#  Copyright (c) 2021.  Nicolai Oswald
#  Copyright (c) 2021.  University of Edinburgh
#  All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are
#  met: redistributions of source code must retain the above copyright
#  notice, this list of conditions and the following disclaimer;
#  redistributions in binary form must reproduce the above copyright
#  notice, this list of conditions and the following disclaimer in the
#  documentation and/or other materials provided with the distribution;
#  neither the name of the copyright holders nor the names of its
#  contributors may be used to endorse or promote products derived from
#  this software without specific prior written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
#  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
#  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
#  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
#  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#

import os
from psutil import virtual_memory

from typing import List, Union, Tuple

from time import sleep

from Backend.Murphi.ModularMurphi import ModularMurphi
from Debug.Monitor.ClassDebug import Debug
from Debug.Monitor.MakeDir import make_dir

from DataObjects.ClassCluster import Cluster
from MurphiLitmusTests.ClassLitmusTest import LitmusTest


def _run_murphi_modular_base(clusters: List[Cluster],
                             filename: str,
                             litmus_test: Union[LitmusTest, None] = None,
                             run_SSP: bool = False,
                             custom_dir: str = ''
                             ) -> Tuple[ModularMurphi, str]:
    def_path = os.getcwd()

    path = "Murphi/"
    if custom_dir:
        path += custom_dir + '/'
    if litmus_test:
        path += litmus_test.test_name.split('.')[0]
    make_dir(path)

    # Generate Murphi file description
    murphi_desc = ModularMurphi(clusters, filename, False, litmus_test)

    return murphi_desc, def_path


def RunMurphiCheck(clusters: List[Cluster],
                   filename: str,
                   litmus_test: Union[LitmusTest, None] = None,
                   memory: int = 0,
                   custom_dir: str = '',
                   run_SSP: bool = False
                   ):
    murphi_desc, def_path = _run_murphi_modular_base(clusters, filename, litmus_test, run_SSP, custom_dir)

    if not memory:
        # Calculate the free memory in Megabyte
        memory = int(virtual_memory().free/2**20) - 8000      # Leave about 1GB of additional free memory

    sleep(0.10)
    murphi_desc.compile_and_run(memory)
    sleep(0.10)

    # Reset the path
    os.chdir(def_path)


def CompileMurphi(clusters: List[Cluster],
                  filename: str,
                  litmus_test: Union[LitmusTest, None] = None,
                  custom_dir: str = '',
                  run_SSP: bool = False
                  ):
    murphi_desc, def_path = _run_murphi_modular_base(clusters, filename, litmus_test, run_SSP, custom_dir)

    sleep(0.10)
    murphi_desc.compile()
    sleep(0.10)

    # Reset the path
    os.chdir(def_path)


def GenerateMurphi(clusters: List[Cluster],
                  filename: str,
                  litmus_test: Union[LitmusTest, None] = None,
                  custom_dir: str = '',
                  run_SSP: bool = False
                  ):

    murphi_desc, def_path = _run_murphi_modular_base(clusters, filename, litmus_test, run_SSP, custom_dir)
    sleep(0.10)

    murphi_desc.gen_make()

    # Reset the path
    os.chdir(def_path)
