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

Work in progress

• ContextualEval
• engines
• analysis tools
• load/save
• GUI
  • AnimUML.js
  • Editor
  • AnimUMLTree
• AnimUMLUtils
• JavaScriptActionLanguageParser
• code generators
• exporters
• diagram generators (for GUI and export)
• transformations
• utils
• build or command line modules
• model input/output connections