Code Overview

The purpose of this page is to give an overview of code organisation.

General Principles

• almost all AnimUML modules are ECMAScript modules
• most modules that are used in the browser are also used in Node.js
  • therefore, using them may require setting up a browser-like environment
    • for instance, globalThis.WebSocket exists in the browser, but not in Node.js by default
      • the Node.js websocket module can be imported (see Dependencies), and injected into globalThis
  • this way, these modules do not need to care about where (browser or Node.js) they are executed from

Modules Overview

This section is a work in progress.

The following layered architecture diagram represents AnimUML's high-level code organization.

Presentation
Diagram	Transformation	Analysis
		Execution/Semantics	External Analysis Tools
Model Representation
Load/Save	Export	Code Generation

Some modules corresponding to each element of this diagram are listed below.

Presentation

• AnimUML.js
• Editor.js

Diagram

• PlantUML-based
  • Export2PlantUML.js
    • toPlantUML(...)
      • state machines
    • allObjectsToPlantUML(...)
      • object diagrams
      • class diagrams
      • both with (optional) embedded state machines
    • (private) js2PlantUMLActivity(...)
      • activity diagrams
  • history/trace
    • History2PlantUMLBranchingHistory.js
    • History2PlantUMLSequence.js
    • History2PlantUMLTiming.js
  • StateSpace2PlantUML.js
    • generates a PlantUML model for a complete state space
    • only applicable to relatively small state spaces
  • utils
    • PlantUMLURI.js
    • PlantUMLUtils.js
• ATLc/web-based
  • TCSVGSequenceTemplates.js
    • the templates generated by the ATLc/web compiler
  • TCSVGSequenceGenerator.js
    • generates TCSVG by wrapping a string containing the appropriate tags
    • uses TCSVGSequenceTemplate.js
  • History2TCSVGSequence.js
    • translates execution trace/history to an ATLc-based sequence diagram
    • uses TCSVGSequenceGenerator.js
  • Interaction2TCSVGSequence.js
    • translates (specification) interactions to ATLc-based sequence diagrams
    • uses TCSVGSequenceGenerator.js

Transformation

• TransformStateMachine2Explicit.js

Analysis

• operators on engines
  • SynchronousCompositionEngine.js
  • AnimUMLSmallerStepsEngine.js
  • AnimUMLTimedEngine.js
  • AnimUMLSynchronousCommunicationEngine.js
  • PooledEngine.js
• built-in analysis tools
  • AnimUMLStaticAnalysis.js
  • Explorer.js
    • deprecated in favor of z2mc
  • ParallelExplorer.js
    • asynchronous version of Explorer.js
    • when used with PooledEngine.js, several steps can be executed concurrently on remotely connected engines
  • DiffExplorer.js
  • AnalysisWorker.js

Execution/Semantics

• standalone engines
  • AnimUMLEngine.js
  • RemoteEngine.js
  • EMIRemoteEngine.js
• observer/monitor engines, for synchronous composition with another engine
  • ObserverAnimUMLEngine.js
    • simple state machine semantics
  • InteractionEngine.js
    • interaction (sequence diagram) interpreter
    • work in progress

External Analysis Tools

• RemoteTool.js

Model Representation

• Model.js
• ModelUtils.js

Load/Save

• Export2AnimUML.js
• ImportFromAnimUML.js
• TranslateToPlantUMLSyntax.js
• CLILoadModel.js
  • for use with Node.js
  • can be used to load different kinds of AnimUML models (JSON, JS, HTML)
• ImportFromPlantUMLClass.js, ImportFromPlantUMLSequence.js, and ImportFromPlantUMLState.js
  • PlantUML-like grammars/parsers/serializers
• Preprocessor.js

Export

• Export2tUML.js
• ExportUtils.js

Code Generation

• Export2C.js

Utils

• Utils.js
• ASTUtils.js
• TemplateUtils.js
• ResourcePool.js