module QuantumSavory

const glcnt = Base.Threads.Atomic{Int128}(0)

function guid()
    Base.Threads.atomic_add!(glcnt, Int128(1)) + 1
end

using Reexport

import Base: unlock, lock, islocked

using DocStringExtensions
using PrettyTables: PrettyTables, pretty_table
using IterTools
import LinearAlgebra
using LinearAlgebra: tr, mul!, eigvecs, norm, normalize, det
import Random
using Random: randperm
using Graphs
import ConcurrentSim
using ConcurrentSim: Environment, Simulation, Store, DelayQueue, Resource,
      Process, @process,
      request, release, now, active_process, timeout, put, get
using ResumableFunctions
import SumTypes
using SumTypes: @sum_type, isvariant, @cases
import Combinatorics
using Combinatorics: powerset

import QuantumClifford
import QuantumClifford: MixedDestabilizer

import QuantumOpticsBase
import QuantumOpticsBase: StateVector, Ket, Operator,
    basisstate, spinup, spindown, sigmap, sigmax, sigmay, sigmaz, destroy, spre, spost

import QuantumOptics
import QuantumOptics: timeevolution

import Gabs

import QuantumInterface: basis, tensor, ⊗, apply!, traceout!, nsubsystems, permutesystems,
    projector, identityoperator, embed, dm, expect, ptrace,
    AbstractOperator, AbstractKet, AbstractSuperOperator,
    Basis, GenericBasis, CompositeBasis, SpinBasis

export apply!, traceout!, removebackref!, nsubsystems
export project_traceout! #TODO should move to QuantumInterface

include("logging.jl")

using QuantumSymbolics:
    AbstractRepresentation, AbstractUse,
    CliffordRepr, consistent_representation, QuantumOpticsRepr, QuantumMCRepr,
    metadata, istree, operation, arguments, Symbolic, SymQObj, # from Symbolics
    HGate, XGate, YGate, ZGate, CPHASEGate, CNOTGate,
    XBasisState, YBasisState, ZBasisState,
    STensorOperator, SScaledOperator, SAddOperator, STensor
using QuantumSymbolics: I # to avoid ambiguity with LinearAlgebra.I
@reexport using QuantumSymbolics

export
    StateRef, RegRef, Register,
    Qubit, Qumode, QuantumStateTrait,
    CliffordRepr, QuantumOpticsRepr, QuantumMCRepr,
    UseAsState, UseAsObservable, UseAsOperation,
    AbstractBackground,
    onchange_tag, onchange,
    # networks.jl
    RegisterNet, channel, qchannel, messagebuffer,
    # logging.jl
    LOG_GROUPS, simulation_log_context,
    # initialize.jl
    initialize!, newstate,
    # subsystemcompose.jl
    subsystemcompose,
    # observable.jl
    observable,
    # uptotime.jl
    uptotime!, overwritetime!,
    # tags.jl and queries.jl and querywait.jl
    AbstractTag, Tag, tag!, untag!, W, ❓, query, queryall, querydelete!, query_wait, querydelete_wait!,
    findfreeslot,
    #messagebuffer.jl
    MessageBuffer,
    # quantumchannel.jl
    QuantumChannel,
    # backgrounds.jl
    T1Decay, T2Dephasing, T1T2Noise, Depolarization, PauliNoise, AmplitudeDamping,
    # noninstant.jl
    AbstractNoninstantOperation, NonInstantGate, ConstantHamiltonianEvolution,
    # measurements.jl
    HomodyneMeasurement,
    # plots.jl
    registernetplot, registernetplot!, registernetplot_axis, resourceplot_axis, generate_map,
    # backends/quantumoptics
    krausops, lindbladop,
    # backends/quantumclifford
    paulinoise


#TODO you can not assume you can always in-place modify a state. Have all these functions work on stateref, not stateref[]
# basically all ::QuantumOptics... should be turned into ::Ref{...}... but an abstract ref

# warnings for not having Ext packages
function __init__()
    if isdefined(Base.Experimental, :register_error_hint)
        Base.Experimental.register_error_hint(MethodError) do io, exc, argtypes, kwargs
            if exc.f === registernetplot
                println(io, "\n`registernetplot!` is implemented as an optional extension dependent on `Makie`; please make sure `Makie` is installed and imported first.")
            elseif exc.f === registernetplot!
                println(io, "\n`registernetplot!` is implemented as an optional extension dependent on `Makie`; please make sure `Makie` is installed and imported first.")
            elseif exc.f === registernetplot_axis
                println(io, "\n`registernetplot_axis` is implemented as an optional extension dependent on `Makie`; please make sure `Makie` is installed and imported first.")
            elseif exc.f === resourceplot_axis
                println(io, "\n`resourceplot_axis` is implemented as an optional extension dependent on `Makie`; please make sure `Makie` is installed and imported first.")
            elseif exc.f === generate_map
                println(io, "\n`generate_map` is implemented as an optional extension dependent on `Tyler`; please make sure `Tyler` is installed and imported first.")
            elseif exc.f === available_slot_types
                println(io, "\n`available_slot_types` is implemented as an optional extension dependent on `InteractiveUtils` and `REPL`; please make sure `InteractiveUtils` and `REPL` are installed and imported first.")
            elseif exc.f === available_background_types
                println(io, "\n`available_background_types` is implemented as an optional extension dependent on `InteractiveUtils` and `REPL`; please make sure `InteractiveUtils` and `REPL` are installed and imported first.")
            elseif exc.f === constructor_metadata
                println(io, "\n`constructor_metadata` is implemented as an optional extension dependent on `InteractiveUtils` and `REPL`; please make sure `InteractiveUtils` and `REPL` are installed and imported first.")
            end
        end
    end
end

include("traits_and_defaults.jl")

include("tags.jl")

include("semaphore.jl")

include("states_registers.jl")
include("quantumchannel.jl")
include("messagebuffer.jl")
include("networks.jl")
include("states_registers_networks_getset.jl")
include("states_registers_networks_shows.jl")
include("show.jl")


include("baseops/subsystemcompose.jl")
include("baseops/initialize.jl")
include("baseops/traceout.jl")
include("baseops/apply.jl")
include("baseops/uptotime.jl")
include("baseops/observable.jl")

include("queries.jl")
include("querywait.jl")

include("representations.jl")
include("domain_validation.jl")
include("backgrounds.jl")
include("noninstant.jl")
include("measurements.jl")

include("backends/quantumoptics/quantumoptics.jl")
include("backends/clifford/clifford.jl")
include("backends/gabs/gabs.jl")
include("backends/gabs/show.jl")

include("ambiguity_fix.jl")

include("concurrentsim.jl")

include("plots.jl")

include("CircuitZoo/CircuitZoo.jl")

include("StatesZoo/StatesZoo.jl")

include("ProtocolZoo/ProtocolZoo.jl")

include("should_upstream.jl")
include("precompile.jl")

end # module
