Revise Component Macros.

Fixes #39

docs/build/assets/themes/documenter-dark.css

@@ -7277,8 +7277,6 @@ html.theme--documenter-dark {
       opacity: 0.2; }
     html.theme--documenter-dark .docstring > section:hover a.docs-sourcelink {
       opacity: 1; }
-  html.theme--documenter-dark .documenter-example-output {
-    background-color: #1f2424; }
   html.theme--documenter-dark .content pre {
     border: 1px solid #5e6d6f; }
   html.theme--documenter-dark .content code {
@@ -7381,7 +7379,6 @@ html.theme--documenter-dark {
       margin-bottom: 0.4em; }
   html.theme--documenter-dark #documenter .docs-main .docs-footer {
     display: flex;
-    flex-wrap: wrap;
     margin-left: 0;
     margin-right: 0;
     border-top: 1px solid #5e6d6f;
@@ -7395,13 +7392,6 @@ html.theme--documenter-dark {
       flex-grow: 1; }
     html.theme--documenter-dark #documenter .docs-main .docs-footer .docs-footer-nextpage {
       text-align: right; }
-    html.theme--documenter-dark #documenter .docs-main .docs-footer .flexbox-break {
-      flex-basis: 100%;
-      height: 0; }
-    html.theme--documenter-dark #documenter .docs-main .docs-footer .footer-message {
-      font-size: 0.8em;
-      margin: 0.5em auto 0 auto;
-      text-align: center; }
   html.theme--documenter-dark #documenter .docs-sidebar {
     display: flex;
     flex-direction: column;

docs/build/assets/themes/documenter-light.css

@@ -7239,9 +7239,6 @@ h1:hover .docs-heading-anchor-permalink, h2:hover .docs-heading-anchor-permalink
   .docstring > section:hover a.docs-sourcelink {
     opacity: 1; }
 
-.documenter-example-output {
-  background-color: white; }
-
 .content pre {
   border: 1px solid #dbdbdb; }
 
@@ -7363,7 +7360,6 @@ html {
 
 #documenter .docs-main .docs-footer {
   display: flex;
-  flex-wrap: wrap;
   margin-left: 0;
   margin-right: 0;
   border-top: 1px solid #dbdbdb;
@@ -7377,13 +7373,6 @@ html {
     flex-grow: 1; }
   #documenter .docs-main .docs-footer .docs-footer-nextpage {
     text-align: right; }
-  #documenter .docs-main .docs-footer .flexbox-break {
-    flex-basis: 100%;
-    height: 0; }
-  #documenter .docs-main .docs-footer .footer-message {
-    font-size: 0.8em;
-    margin: 0.5em auto 0 auto;
-    text-align: center; }
 
 #documenter .docs-sidebar {
   display: flex;

src/Causal.jl

@@ -103,6 +103,8 @@ export readtime!,
     drive!, 
     approve!
 
+include("components/constants.jl")
+
 include("components/sources/clock.jl")
 export Clock, 
     isrunning, 
@@ -125,7 +127,6 @@ export @def_source,
     ExponentialGenerator,
     DampedExponentialGenerator
 
-
 include("components/systems/staticsystems/staticsystems.jl")
 export @def_static_system,
     StaticSystem,

src/components/constants.jl

@@ -0,0 +1,48 @@
+# This file includes the type symbols of the fields to be added to the user defined components. 
+
+# NOTE: This is one-time defines to avoid name name conflicts with the user defined type names. 
+
+# `trigger` field  type symbol. Common to all AbstractComponent
+const TRIGGER_TYPE_SYMBOL = gensym() 
+
+# `handshake` field type symbol. Commona to all AbstractComponent.
+const HANDSHAKE_TYPE_SYMBOL = gensym() 
+
+# `callbacks` field type symbol. Commone to all AbstractComponent
+const CALLBACKS_TYPE_SYMBOL = gensym() 
+
+# `id` field type symbol. Common to all AbstractComponent. 
+const ID_TYPE_SYMBOL = gensym() 
+
+# `modelargs` field type symbol. Common to all AbstractDynamicalSystem 
+const MODEL_ARGS_TYPE_SYMBOL = gensym() 
+
+# `modelkwargs` field type symbol. Common to all AbstractDynamicalSystem
+const MODEL_KWARGS_TYPE_SYMBOL = gensym() 
+
+# `solverargs` field type symbol. Common to all AbstractDynamicalSystem
+const SOLVER_ARGS_TYPE_SYMBOL = gensym() 
+
+# `solverkwargs` field type symbol. Common to all AbstractDynamicalSystem
+const SOLVER_KWARGS_TYPE_SYMBOL = gensym() 
+
+# `alg` field type symbol. Common to all AbstractDynamicalSystem
+const ALG_TYPE_SYMBOL = gensym() 
+
+# `integrator` field type symbol. Common to all AbstractDynamicalSystem
+const INTEGRATOR_TYPE_SYMBOL = gensym() 
+
+# `input` field type symbol. Common to all AbstractSink 
+const INPUT_TYPE_SYMBOL = gensym() 
+
+# `plugin` field type symbol. Common to all AbstractSink 
+const PLUGIN_TYPE_SYMBOL = gensym() 
+
+# `timebuf` field type symbol. Common to all AbstractSink 
+const TIMEBUF_TYPE_SYMBOL = gensym() 
+
+# `databuf` field type symbol. Common to all AbstractSink 
+const DATABUF_TYPE_SYMBOL = gensym() 
+
+# `sinkcallback` field type symbol. Common to all AbstractSink 
+const SINK_CALLBACK_TYPE_SYMBOL = gensym() 

src/components/sinks/sinks.jl

@@ -52,22 +52,22 @@ macro def_sink(ex)
     =#
     ex.args[2].head == :(<:) && ex.args[2].args[2] == :AbstractSink || 
         error("Invalid usage. The type should be a subtype of AbstractSink.\n$ex")
-    TR, HS, CB, ID, IP, PL, TB, DB, SCB = [gensym() for i in 1 : 9]
+    # TR, HS, CB, ID, IP, PL, TB, DB, SCB = [gensym() for i in 1 : 9]
     fields = quote
-        trigger::$(TR) = Inpin()
-        handshake::$(HS) = Outpin{Bool}()
-        callbacks::$(CB) = nothing
+        trigger::$(TRIGGER_TYPE_SYMBOL) = Inpin()
+        handshake::$(HANDSHAKE_TYPE_SYMBOL) = Outpin{Bool}()
+        callbacks::$(CALLBACKS_TYPE_SYMBOL) = nothing
         name::Symbol = Symbol()
-        id::$(ID) = Causal.uuid4()
-        input::$(IP) = Inport()
+        id::$(ID_TYPE_SYMBOL) = Causal.uuid4()
+        input::$(INPUT_TYPE_SYMBOL) = Inport()
         buflen::Int = 64
-        plugin::$(PL) = nothing
-        timebuf::$(TB) = Buffer(buflen) 
-        databuf::$(DB) = length(input) == 1 ? Buffer(buflen) :  Buffer(length(input), buflen)
-        sinkcallback::$(SCB) = plugin === nothing ? 
+        plugin::$(PLUGIN_TYPE_SYMBOL) = nothing
+        timebuf::$(TIMEBUF_TYPE_SYMBOL) = Buffer(buflen) 
+        databuf::$(DATABUF_TYPE_SYMBOL) = length(input) == 1 ? Buffer(buflen) :  Buffer(length(input), buflen)
+        sinkcallback::$(SINK_CALLBACK_TYPE_SYMBOL) = plugin === nothing ? 
             Callback(sink->ishit(databuf), sink->action(sink, outbuf(timebuf), outbuf(databuf)), true, id) :
             Callback(sink->ishit(databuf), sink->action(sink, outbuf(timebuf), plugin.process(outbuf(databuf))), true, id)
-    end, [TR, HS, CB, ID, IP, PL, TB, DB, SCB]
+    end, [TRIGGER_TYPE_SYMBOL, HANDSHAKE_TYPE_SYMBOL, CALLBACKS_TYPE_SYMBOL, ID_TYPE_SYMBOL, INPUT_TYPE_SYMBOL, PLUGIN_TYPE_SYMBOL, TIMEBUF_TYPE_SYMBOL, DATABUF_TYPE_SYMBOL, SINK_CALLBACK_TYPE_SYMBOL]
     _append_common_fields!(ex, fields...)
     deftype(ex)
 end

src/components/sources/generators.jl

@@ -48,28 +48,15 @@ julia> gen.output
 ```
 """
 macro def_source(ex) 
-    #= NOTE: 
-        Generate the parameter names TR, HS, CB, ID of types of trigger, handshake, callbacks, id by using 
-        `gensym` to avoid duplicate type parameter names so that the users can parametrizde their types as 
-        
-        @def_source struct Mygen{RO, TR} <: AbstractSource 
-            readout::RO = t -> sin(t)
-            output::TR = Outport() 
-        end
-        
-        Note that the parameter name of output is TR. But, since the parameter name TR of trigger of the compnent 
-        is generated by `gensym`, we get rid of duplicate parameter names.
-    =#
     ex.args[2].head == :(<:) && ex.args[2].args[2] == :AbstractSource || 
         error("Invalid usage. The type should be a subtype of AbstractSource.\n$ex")
-    TR, HS, CB, ID = [gensym() for i in 1 : 4]
     fields = quote
-        trigger::$(TR) = Inpin()
-        handshake::$(HS) = Outpin{Bool}()
-        callbacks::$(CB) = nothing
+        trigger::$(TRIGGER_TYPE_SYMBOL) = Inpin()
+        handshake::$(HANDSHAKE_TYPE_SYMBOL) = Outpin{Bool}()
+        callbacks::$(CALLBACKS_TYPE_SYMBOL) = nothing
         name::Symbol = Symbol()
-        id::$(ID) = Causal.uuid4()
-    end, [TR, HS, CB, ID]
+        id::$(ID_TYPE_SYMBOL) = Causal.uuid4()
+    end, [TRIGGER_TYPE_SYMBOL, HANDSHAKE_TYPE_SYMBOL, CALLBACKS_TYPE_SYMBOL, ID_TYPE_SYMBOL]
     _append_common_fields!(ex, fields...)
     deftype(ex)
 end

src/components/systems/dynamicalsystems/daesystems.jl

@@ -83,24 +83,23 @@ macro def_dae_system(ex)
         is generated by `gensym`, we get rid of duplicate parameter names.
     =#
     checksyntax(ex, :AbstractDAESystem)
-    TR, HS, CB, ID, MA, MK, SA, SK, AL, IT = [gensym() for i in 1 : 10]
     fields = quote
-        trigger::$(TR) = Inpin()
-        handshake::$(HS) = Outpin{Bool}()
-        callbacks::$(CB) = nothing
+        trigger::$(TRIGGER_TYPE_SYMBOL) = Inpin()
+        handshake::$(HANDSHAKE_TYPE_SYMBOL) = Outpin{Bool}()
+        callbacks::$(CALLBACKS_TYPE_SYMBOL) = nothing
         name::Symbol = Symbol()
-        id::$(ID) = Causal.uuid4()
+        id::$(ID_TYPE_SYMBOL) = Causal.uuid4()
         t::Float64 = 0.
-        modelargs::$(MA) = () 
-        modelkwargs::$(MK) = NamedTuple() 
-        solverargs::$(SA) = () 
-        solverkwargs::$(SK) = NamedTuple() 
-        alg::$(AL) = Causal.IDA()
-        integrator::$(IT) = Causal.construct_integrator(Causal.DAEProblem, input, righthandside, state, t, modelargs, 
+        modelargs::$(MODEL_ARGS_TYPE_SYMBOL) = () 
+        modelkwargs::$(MODEL_KWARGS_TYPE_SYMBOL) = NamedTuple() 
+        solverargs::$(SOLVER_ARGS_TYPE_SYMBOL) = () 
+        solverkwargs::$(SOLVER_KWARGS_TYPE_SYMBOL) = NamedTuple() 
+        alg::$(ALG_TYPE_SYMBOL) = Causal.IDA()
+        integrator::$(INTEGRATOR_TYPE_SYMBOL) = Causal.construct_integrator(Causal.DAEProblem, input, righthandside, state, t, modelargs, 
             solverargs; alg=alg, stateder=stateder, modelkwargs=(; 
             zip((keys(modelkwargs)..., :differential_vars), (values(modelkwargs)..., diffvars))...), 
             solverkwargs=solverkwargs, numtaps=3)
-    end, [TR, HS, CB, ID, MA, MK, SA, SK, AL, IT]
+    end, [TRIGGER_TYPE_SYMBOL, HANDSHAKE_TYPE_SYMBOL, CALLBACKS_TYPE_SYMBOL, ID_TYPE_SYMBOL, MODEL_ARGS_TYPE_SYMBOL, MODEL_KWARGS_TYPE_SYMBOL, SOLVER_ARGS_TYPE_SYMBOL, SOLVER_KWARGS_TYPE_SYMBOL, ALG_TYPE_SYMBOL, INTEGRATOR_TYPE_SYMBOL]
     _append_common_fields!(ex, fields...)
     deftype(ex)
 end

src/components/systems/dynamicalsystems/ddesystems.jl

@@ -82,48 +82,28 @@ julia> ds = MyDDESystem();
 ```
 """
 macro def_dde_system(ex)
-    #= NOTE: 
-        Generate the parameter names TR, HS, CB, ID, MA, MK, SA, SK, AL, IT  of types of trigger, handshake, callbacks, 
-        id, modelargs, modelkwargs, solverargs, solverkwargs, alg, integrator by using `gensym` to avoid duplicate type 
-        parameter names so that the users can parametrizde their types as 
-        
-        @def_dde_system mutable struct MyDDESystem{CL, DL, RH, HST, RO, ST, IP, TR} <: AbstractDDESystem
-            constlags::CL 
-            depslags::DL 
-            righthandside::RH 
-            history::HST 
-            readout::RO 
-            state::ST 
-            input::IP 
-            output::TR
-        end
-                
-        Note that the parameter name of output is TR. But, since the parameter name TR of trigger of the compnent 
-        is generated by `gensym`, we get rid of duplicate parameter names.
-    =#
     checksyntax(ex, :AbstractDDESystem)
-    TR, HS, CB, ID, MA, MK, SA, SK, AL, IT = [gensym() for i in 1 : 10]
     fields = quote
-        trigger::$(TR) = Inpin()
-        handshake::$(HS) = Outpin{Bool}()
-        callbacks::$(CB) = nothing
+        trigger::$(TRIGGER_TYPE_SYMBOL) = Inpin()
+        handshake::$(HANDSHAKE_TYPE_SYMBOL) = Outpin{Bool}()
+        callbacks::$(CALLBACKS_TYPE_SYMBOL) = nothing
         name::Symbol = Symbol()
-        id::$(ID) = Causal.uuid4()
+        id::$(ID_TYPE_SYMBOL) = Causal.uuid4()
         t::Float64 = 0.
-        modelargs::$(MA) = () 
-        modelkwargs::$(MK) = NamedTuple() 
-        solverargs::$(SA) = () 
-        solverkwargs::$(SK) = NamedTuple() 
-        alg::$(AL) = Causal.MethodOfSteps(Causal.Tsit5())
-        integrator::$(IT) = Causal.construct_integrator(
+        modelargs::$(MODEL_ARGS_TYPE_SYMBOL) = () 
+        modelkwargs::$(MODEL_KWARGS_TYPE_SYMBOL) = NamedTuple() 
+        solverargs::$(SOLVER_ARGS_TYPE_SYMBOL) = () 
+        solverkwargs::$(SOLVER_KWARGS_TYPE_SYMBOL) = NamedTuple() 
+        alg::$(ALG_TYPE_SYMBOL) = Causal.MethodOfSteps(Causal.Tsit5())
+        integrator::$(INTEGRATOR_TYPE_SYMBOL) = Causal.construct_integrator(
             Causal.DDEProblem, input, (righthandside, history), state, t, modelargs, solverargs; 
             alg=alg, modelkwargs=(; 
             zip(
                 (keys(modelkwargs)..., :constant_lags, :dependent_lags), 
                 (values(modelkwargs)..., constlags, depslags))...
                 ), 
             solverkwargs=solverkwargs, numtaps=3)
-    end, [TR, HS, CB, ID, MA, MK, SA, SK, AL, IT]
+    end, [TRIGGER_TYPE_SYMBOL, HANDSHAKE_TYPE_SYMBOL, CALLBACKS_TYPE_SYMBOL, ID_TYPE_SYMBOL, MODEL_ARGS_TYPE_SYMBOL, MODEL_KWARGS_TYPE_SYMBOL, SOLVER_ARGS_TYPE_SYMBOL, SOLVER_KWARGS_TYPE_SYMBOL, ALG_TYPE_SYMBOL, INTEGRATOR_TYPE_SYMBOL]
     _append_common_fields!(ex, fields...)
     deftype(ex)
 end

src/components/systems/dynamicalsystems/discretesystems.jl

@@ -78,22 +78,22 @@ macro def_discrete_system(ex)
         is generated by `gensym`, we get rid of duplicate parameter names.
     =#
     checksyntax(ex, :AbstractDiscreteSystem)
-    TR, HS, CB, ID, MA, MK, SA, SK, AL, IT = [gensym() for i in 1 : 10]
+    # TR, HS, CB, ID, MA, MK, SA, SK, AL, IT = [gensym() for i in 1 : 10]
     fields = quote
-        trigger::$(TR) = Inpin()
-        handshake::$(HS) = Outpin{Bool}()
-        callbacks::$(CB) = nothing
+        trigger::$(TRIGGER_TYPE_SYMBOL) = Inpin()
+        handshake::$(HANDSHAKE_TYPE_SYMBOL) = Outpin{Bool}()
+        callbacks::$(CALLBACKS_TYPE_SYMBOL) = nothing
         name::Symbol = Symbol()
-        id::$(ID )= Causal.uuid4()
+        id::$(ID_TYPE_SYMBOL)= Causal.uuid4()
         t::Float64 = 0.
-        modelargs::$(MA) = () 
-        modelkwargs::$(MK) = NamedTuple() 
-        solverargs::$(SA) = () 
-        solverkwargs::$(SK) = NamedTuple() 
-        alg::$(AL) = Causal.FunctionMap()
-        integrator::$(IT) = Causal.construct_integrator(Causal.DiscreteProblem, input, righthandside, state, t,
+        modelargs::$(MODEL_ARGS_TYPE_SYMBOL) = () 
+        modelkwargs::$(MODEL_KWARGS_TYPE_SYMBOL) = NamedTuple() 
+        solverargs::$(SOLVER_ARGS_TYPE_SYMBOL) = () 
+        solverkwargs::$(SOLVER_KWARGS_TYPE_SYMBOL) = NamedTuple() 
+        alg::$(ALG_TYPE_SYMBOL) = Causal.FunctionMap()
+        integrator::$(INTEGRATOR_TYPE_SYMBOL) = Causal.construct_integrator(Causal.DiscreteProblem, input, righthandside, state, t,
             modelargs, solverargs; alg=alg, modelkwargs=modelkwargs, solverkwargs=solverkwargs, numtaps=3)
-    end, [TR, HS, CB, ID, MA, MK, SA, SK, AL, IT]
+    end, [TRIGGER_TYPE_SYMBOL, HANDSHAKE_TYPE_SYMBOL, CALLBACKS_TYPE_SYMBOL, ID_TYPE_SYMBOL, MODEL_ARGS_TYPE_SYMBOL, MODEL_KWARGS_TYPE_SYMBOL, SOLVER_ARGS_TYPE_SYMBOL, SOLVER_KWARGS_TYPE_SYMBOL, ALG_TYPE_SYMBOL, INTEGRATOR_TYPE_SYMBOL]
     _append_common_fields!(ex, fields...)
     deftype(ex)
 end

src/components/systems/dynamicalsystems/odesystems.jl

@@ -65,39 +65,22 @@ julia> ds.input
 ```
 """
 macro def_ode_system(ex) 
-    #= NOTE: 
-        Generate the parameter names TR, HS, CB, ID, MA, MK, SA, SK, AL, IT  of types of trigger, handshake, callbacks, 
-        id, modelargs, modelkwargs, solverargs, solverkwargs, alg, integrator by using `gensym` to avoid duplicate type 
-        parameter names so that the users can parametrizde their types as 
-        
-        @def_discrete_system mutablestruct MyODESystem{RH, RO, ST, IP, TR} <: AbstractODESystem
-            righthandside::RH
-            readout::RO 
-            state::ST 
-            input::IP 
-            output::TR
-        end
-                
-        Note that the parameter name of output is TR. But, since the parameter name TR of trigger of the compnent 
-        is generated by `gensym`, we get rid of duplicate parameter names.
-    =#
     checksyntax(ex, :AbstractODESystem)
-    TR, HS, CB, ID, MA, MK, SA, SK, AL, IT = [gensym() for i in 1 : 10]
     fields = quote
-        trigger::$(TR) = Inpin()
-        handshake::$(HS) = Outpin{Bool}()
-        callbacks::$(CB) = nothing
+        trigger::$(TRIGGER_TYPE_SYMBOL) = Inpin()
+        handshake::$(HANDSHAKE_TYPE_SYMBOL) = Outpin{Bool}()
+        callbacks::$(CALLBACKS_TYPE_SYMBOL) = nothing
         name::Symbol = Symbol()
-        id::$(ID) = Causal.uuid4()
+        id::$(ID_TYPE_SYMBOL) = Causal.uuid4()
         t::Float64 = 0.
-        modelargs::$(MA) = () 
-        modelkwargs::$(MK) = NamedTuple() 
-        solverargs::$(SA) = () 
-        solverkwargs::$(SK) = NamedTuple() 
-        alg::$(AL) = Causal.Tsit5()
-        integrator::$(IT) = Causal.construct_integrator(Causal.ODEProblem, input, righthandside, state, t, modelargs, 
+        modelargs::$(MODEL_ARGS_TYPE_SYMBOL) = () 
+        modelkwargs::$(MODEL_KWARGS_TYPE_SYMBOL) = NamedTuple() 
+        solverargs::$(SOLVER_ARGS_TYPE_SYMBOL) = () 
+        solverkwargs::$(SOLVER_KWARGS_TYPE_SYMBOL) = NamedTuple() 
+        alg::$(ALG_TYPE_SYMBOL) = Causal.Tsit5()
+        integrator::$(INTEGRATOR_TYPE_SYMBOL) = Causal.construct_integrator(Causal.ODEProblem, input, righthandside, state, t, modelargs, 
             solverargs; alg=alg, modelkwargs=modelkwargs, solverkwargs=solverkwargs, numtaps=3)
-    end, [TR, HS, CB, ID, MA, MK, SA, SK, AL, IT]
+    end, [TRIGGER_TYPE_SYMBOL, HANDSHAKE_TYPE_SYMBOL, CALLBACKS_TYPE_SYMBOL, ID_TYPE_SYMBOL, MODEL_ARGS_TYPE_SYMBOL, MODEL_KWARGS_TYPE_SYMBOL, SOLVER_ARGS_TYPE_SYMBOL, SOLVER_KWARGS_TYPE_SYMBOL, ALG_TYPE_SYMBOL, INTEGRATOR_TYPE_SYMBOL]
     _append_common_fields!(ex, fields...)
     deftype(ex)
 end