Commit: 5fe4f028e4acddef550d8a026f27c595bee58112 - CCastle2 (hg)

Castle: The best Real-Time/Embedded/HighTech language EVER. Attempt 2

Commit MetaInfo

• Revision: 5fe4f028e4acddef550d8a026f27c595bee58112 (tree)
• Time: 2023-10-09 18:15:38
• Author: Albert Mietus < albert AT mietus DOT nl >
• Commiter: Albert Mietus < albert AT mietus DOT nl >

Log Message

Some rst/uml diagrams added on TestDoubles/AIGR :protocols

Change Summary

• modified: DocParts/Design/231005-aigr-CompProto.rst
• add: DocParts/Design/00.OLD-Peg.rst
• add: DocParts/Design/231009_TD-AIGR_3ptotocols.rst
• delete: DocParts/Design/OLD-Peg.rst

Incremental Difference

diff -r b8d358473d84 -r 5fe4f028e4ac DocParts/Design/00.OLD-Peg.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/DocParts/Design/00.OLD-Peg.rst	Mon Oct 09 11:15:38 2023 +0200
@@ -0,0 +1,139 @@
+OLD-Peg Diagram
+===============
+
+This anayse/design(?) date from  around 2021/2022
+
+.. UML::
+
+   @startuml
+
+   package _base {
+
+   abstract AST_BASE {
+     -_parse_tree
+     +position()
+     +position_end()
+     ~serialize()
+   }
+
+   class ID {
+     +name
+     #validate_or_raise()
+   }
+
+   ID  =|> AST_BASE
+   }
+
+   package MixIns  #Gray {
+
+     class MixIn_value_attribute<MixIn> {
+     _value
+     value()
+     }
+
+     class MixIn_expr_attribute<MixIn> {
+     _expr
+     expr()
+     }
+
+     class MixIn_children_tuple<MixIn> {
+      _children :Tuple
+     __len__()
+     __getitem__()
+     __iter__()
+     }
+   }
+
+   package Peg #0077ff {
+
+   abstract PEG
+   AST_BASE <|== PEG
+
+
+
+   abstract Terminal
+   PEG                   <|==   Terminal
+   MixIn_value_attribute <|...  Terminal
+   Terminal              <|==   StrTerm
+   Terminal              <|==   RexExpTerm
+   Terminal              <|==   Number
+
+   abstract    Markers #Orange
+   annotation  EOF     #Orange
+   PEG         <|==    Markers
+   Markers     <|==    EOF
+
+   abstract NonTerminal
+   PEG          <|== NonTerminal
+   abstract Expression
+   NonTerminal  <|== Expression
+
+   class Setting  {
+    name  : ID
+    value
+   }
+   PEG      <|==  Setting
+
+   class Rule {
+     name  :ID
+     expr  :[] Expression
+   }
+   NonTerminal  <|==  Rule
+
+   interface Rules
+   PEG                   <|==    Rules
+   MixIn_children_tuple  <|...  Rules
+   Rules                 <|==    ParseRules
+   Rules                 <|==    Settings
+
+   class Grammar {
+     +all_rules    :Rules
+     -parse_rules  :ParseRules
+     -settings     :Settings
+   }
+   NonTerminal  <|== Grammar
+
+
+   abstract Group
+   Expression            <|== Group
+   Group                 <|== UnorderedGroup
+   MixIn_expr_attribute  <|... UnorderedGroup
+   abstract Quantity
+   Group                   <|==    Quantity
+   MixIn_expr_attribute    <|...    Quantity
+   Expression              <|==    Sequence
+   MixIn_children_tuple    <|...  Sequence
+
+   Expression             <|==   OrderedChoice
+   MixIn_children_tuple   <|...  OrderedChoice
+
+   class Optional   << (?, #0077ff) >>
+   Quantity          <|==   Optional
+   class ZeroOrMore << (*, #0077ff) >>
+   Quantity          <|==   ZeroOrMore
+   class OneOrMore  << (+, #0077ff) >>
+   Quantity          <|==   OneOrMore
+
+   abstract Predicate
+   Expression             <|==   Predicate
+   MixIn_expr_attribute   <|... Predicate
+   class AndPredicate << (&, #0077ff) notconsuming >>
+   Predicate               <|== AndPredicate
+   class NotPredicate << (! ,#0077ff) not consuming >>
+   Predicate               <|== NotPredicate
+
+   }
+   @enduml
+
+
+
+
+
+
+
+
+
+
+
+
+

diff -r b8d358473d84 -r 5fe4f028e4ac DocParts/Design/231005-aigr-CompProto.rst
--- a/DocParts/Design/231005-aigr-CompProto.rst	Sun Oct 08 23:28:37 2023 +0200
+++ b/DocParts/Design/231005-aigr-CompProto.rst	Mon Oct 09 11:15:38 2023 +0200
@@ -1,4 +1,8 @@
-AIGR:: ComponentInterface and Protocols (231005)
+.. -*- plantuml -*-
+.. filename: date of start
+.. date in title: last version
+
+AIGR:: ComponentInterface and Protocols (231009)
 ================================================
 
 .. uml::
@@ -6,65 +10,41 @@
    @startuml
 
    abstract AIGR
-   class CompomnentInterface
+   class ComponentInterface
    class Protocol
    class EventProtocol
    class Port {
     - direction :PortDirection
     - type :PortType
    }
-
-
    abstract ProtocolWrapper {
     -based_on\n(the Generic Protocol)
    }
-
    class Argument <<(S,lightgreen)>> {
     +value  :Any
     +name  :Optional[Str]
    }
-
    class TypedParameters <<(S,lightgreen)>> {
     +name :str
     +type :Type
    }
-
    class Type <<(T,lightblue)>>
+   '--------------------
 
-   AIGR <-- Protocol
-   AIGR <-- Event
-   AIGR <-- CompomnentInterface
-
-   CompomnentInterface <--- CompomnentInterface: based_on
-   CompomnentInterface *-- "*" Port
-
+   ComponentInterface   <---  ComponentInterface: based_on
+   Port "*"             -*    ComponentInterface
 
    Protocol <--- Protocol: based_on
    Protocol <--  EventProtocol
    Protocol <--  ProtocolWrapper
 
-
    ProtocolWrapper *- "+"Argument
 
-   EventProtocol *--  "*"  Event: events
+   EventProtocol *-  "*"  Event: events
    Event         *-- "*"   TypedParameters : typedParameters
    Event         o- "?"    Type: returns
 
-   Port o--- Protocol: type
-
-
-   package ToDesign  <<Rectangle>> #gray {
-   class Compomnent
-   class CompomnentImplementation
-   Compomnent *- CompomnentInterface
-   Compomnent *- CompomnentImplementation
+   Port o. Protocol: type
 
-   }
+   @enduml
 
-   package ToDo/Later  <<Rectangle>> #gray {
-     Protocol <-  DataProtocol
-     Protocol <--  StreamProtocol
-
-   }
-   @enduml
-            

diff -r b8d358473d84 -r 5fe4f028e4ac DocParts/Design/231009_TD-AIGR_3ptotocols.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/DocParts/Design/231009_TD-AIGR_3ptotocols.rst	Mon Oct 09 11:15:38 2023 +0200
@@ -0,0 +1,42 @@
+.. -*- plantuml -*-
+
+TestDoubles/AIGR: The protocols of the Sieve
+============================================
+
+.. uml::
+
+   @startuml
+
+   object StartSieve <<EventProtocol>>
+   object runTo <<Event>>{
+    max: int
+   }
+   object newMax <<Event>> {
+     max: int
+   }
+   StartSieve *-- runTo
+   StartSieve *-- newMax
+
+   '---
+
+   object SlowStart << EventProtocol>>
+   object queue_max <<TypedParameter>> {
+       :int
+    }
+   object setMax <<Event>> {
+     setMax :int
+   }
+   SlowStart *-- setMax
+   SlowStart *- queue_max
+
+   '---
+
+   object SimpleSieve <<EventProtocol>>
+   SlowStart <-- SimpleSieve: based_on
+
+   object input <<Event>> {
+     try :int
+   }
+   SimpleSieve *--input
+
+   @enduml

diff -r b8d358473d84 -r 5fe4f028e4ac DocParts/Design/OLD-Peg.rst
--- a/DocParts/Design/OLD-Peg.rst	Sun Oct 08 23:28:37 2023 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,139 +0,0 @@
-OLD-Peg Diagram
-===============
-
-This anayse/design(?) date from  around 2021/2022
-
-.. UML::
-
-   @startuml
-
-   package _base {
-
-   abstract AST_BASE {
-     -_parse_tree
-     +position()
-     +position_end()
-     ~serialize()
-   }
-
-   class ID {
-     +name
-     #validate_or_raise()
-   }
-
-   ID  =|> AST_BASE
-   }
-
-   package MixIns  #Gray {
-
-     class MixIn_value_attribute<MixIn> {
-     _value
-     value()
-     }
-
-     class MixIn_expr_attribute<MixIn> {
-     _expr
-     expr()
-     }
-
-     class MixIn_children_tuple<MixIn> {
-      _children :Tuple
-     __len__()
-     __getitem__()
-     __iter__()
-     }
-   }
-
-   package Peg #0077ff {
-
-   abstract PEG
-   AST_BASE <|== PEG
-
-
-
-   abstract Terminal
-   PEG                   <|==   Terminal
-   MixIn_value_attribute <|...  Terminal
-   Terminal              <|==   StrTerm
-   Terminal              <|==   RexExpTerm
-   Terminal              <|==   Number
-
-   abstract    Markers #Orange
-   annotation  EOF     #Orange
-   PEG         <|==    Markers
-   Markers     <|==    EOF
-
-   abstract NonTerminal
-   PEG          <|== NonTerminal
-   abstract Expression
-   NonTerminal  <|== Expression
-
-   class Setting  {
-    name  : ID
-    value
-   }
-   PEG      <|==  Setting
-
-   class Rule {
-     name  :ID
-     expr  :[] Expression
-   }
-   NonTerminal  <|==  Rule
-
-   interface Rules
-   PEG                   <|==    Rules
-   MixIn_children_tuple  <|...  Rules
-   Rules                 <|==    ParseRules
-   Rules                 <|==    Settings
-
-   class Grammar {
-     +all_rules    :Rules
-     -parse_rules  :ParseRules
-     -settings     :Settings
-   }
-   NonTerminal  <|== Grammar
-
-
-   abstract Group
-   Expression            <|== Group
-   Group                 <|== UnorderedGroup
-   MixIn_expr_attribute  <|... UnorderedGroup
-   abstract Quantity
-   Group                   <|==    Quantity
-   MixIn_expr_attribute    <|...    Quantity
-   Expression              <|==    Sequence
-   MixIn_children_tuple    <|...  Sequence
-
-   Expression             <|==   OrderedChoice
-   MixIn_children_tuple   <|...  OrderedChoice
-
-   class Optional   << (?, #0077ff) >>
-   Quantity          <|==   Optional
-   class ZeroOrMore << (*, #0077ff) >>
-   Quantity          <|==   ZeroOrMore
-   class OneOrMore  << (+, #0077ff) >>
-   Quantity          <|==   OneOrMore
-
-   abstract Predicate
-   Expression             <|==   Predicate
-   MixIn_expr_attribute   <|... Predicate
-   class AndPredicate << (&, #0077ff) notconsuming >>
-   Predicate               <|== AndPredicate
-   class NotPredicate << (! ,#0077ff) not consuming >>
-   Predicate               <|== NotPredicate
-
-   }
-   @enduml
-
-
-
-
-
-
-
-
-
-
-
-
-