feat: Add comprehensive documentation suite and reorganize project structure
- Created complete documentation in docs/ directory - Added PROJECT_OVERVIEW.md with feature highlights and getting started guide - Added ARCHITECTURE.md with system design and technical details - Added SECURITY.md with comprehensive security implementation guide - Added DEVELOPMENT.md with development workflows and best practices - Added DEPLOYMENT.md with production deployment instructions - Added API.md with complete REST API documentation - Added CONTRIBUTING.md with contribution guidelines - Added CHANGELOG.md with version history and migration notes - Reorganized all documentation files into docs/ directory for better organization - Updated README.md with proper documentation links and quick navigation - Enhanced project structure with professional documentation standards
This commit is contained in:
SamiAhmed7777
67
f_scripts/shared/codemirror/mode/modelica/index.html
vendored
Normal file
67
f_scripts/shared/codemirror/mode/modelica/index.html
vendored
Normal file
@@ -0,0 +1,67 @@
|
||||
<!doctype html>
|
||||
|
||||
<title>CodeMirror: Modelica mode</title>
|
||||
<meta charset="utf-8"/>
|
||||
<link rel=stylesheet href="../../doc/docs.css">
|
||||
|
||||
<link rel="stylesheet" href="../../lib/codemirror.css">
|
||||
<script src="../../lib/codemirror.js"></script>
|
||||
<script src="../../addon/edit/matchbrackets.js"></script>
|
||||
<link rel="stylesheet" href="../../addon/hint/show-hint.css">
|
||||
<script src="../../addon/hint/show-hint.js"></script>
|
||||
<script src="modelica.js"></script>
|
||||
<style>.CodeMirror {border: 2px inset #dee;}</style>
|
||||
<div id=nav>
|
||||
<a href="http://codemirror.net"><h1>CodeMirror</h1><img id=logo src="../../doc/logo.png"></a>
|
||||
|
||||
<ul>
|
||||
<li><a href="../../index.html">Home</a>
|
||||
<li><a href="../../doc/manual.html">Manual</a>
|
||||
<li><a href="https://github.com/codemirror/codemirror">Code</a>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><a href="../index.html">Language modes</a>
|
||||
<li><a class=active href="#">Modelica</a>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<article>
|
||||
<h2>Modelica mode</h2>
|
||||
|
||||
<div><textarea id="modelica">
|
||||
model BouncingBall
|
||||
parameter Real e = 0.7;
|
||||
parameter Real g = 9.81;
|
||||
Real h(start=1);
|
||||
Real v;
|
||||
Boolean flying(start=true);
|
||||
Boolean impact;
|
||||
Real v_new;
|
||||
equation
|
||||
impact = h <= 0.0;
|
||||
der(v) = if flying then -g else 0;
|
||||
der(h) = v;
|
||||
when {h <= 0.0 and v <= 0.0, impact} then
|
||||
v_new = if edge(impact) then -e*pre(v) else 0;
|
||||
flying = v_new > 0;
|
||||
reinit(v, v_new);
|
||||
end when;
|
||||
annotation (uses(Modelica(version="3.2")));
|
||||
end BouncingBall;
|
||||
</textarea></div>
|
||||
|
||||
<script>
|
||||
var modelicaEditor = CodeMirror.fromTextArea(document.getElementById("modelica"), {
|
||||
lineNumbers: true,
|
||||
matchBrackets: true,
|
||||
mode: "text/x-modelica"
|
||||
});
|
||||
var mac = CodeMirror.keyMap.default == CodeMirror.keyMap.macDefault;
|
||||
CodeMirror.keyMap.default[(mac ? "Cmd" : "Ctrl") + "-Space"] = "autocomplete";
|
||||
</script>
|
||||
|
||||
<p>Simple mode that tries to handle Modelica as well as it can.</p>
|
||||
|
||||
<p><strong>MIME types defined:</strong> <code>text/x-modelica</code>
|
||||
(Modlica code).</p>
|
||||
</article>
|
||||
245
f_scripts/shared/codemirror/mode/modelica/modelica.js
vendored
Normal file
245
f_scripts/shared/codemirror/mode/modelica/modelica.js
vendored
Normal file
@@ -0,0 +1,245 @@
|
||||
// CodeMirror, copyright (c) by Marijn Haverbeke and others
|
||||
// Distributed under an MIT license: http://codemirror.net/LICENSE
|
||||
|
||||
// Modelica support for CodeMirror, copyright (c) by Lennart Ochel
|
||||
|
||||
(function(mod) {
|
||||
if (typeof exports == "object" && typeof module == "object") // CommonJS
|
||||
mod(require("../../lib/codemirror"));
|
||||
else if (typeof define == "function" && define.amd) // AMD
|
||||
define(["../../lib/codemirror"], mod);
|
||||
else // Plain browser env
|
||||
mod(CodeMirror);
|
||||
})
|
||||
|
||||
(function(CodeMirror) {
|
||||
"use strict";
|
||||
|
||||
CodeMirror.defineMode("modelica", function(config, parserConfig) {
|
||||
|
||||
var indentUnit = config.indentUnit;
|
||||
var keywords = parserConfig.keywords || {};
|
||||
var builtin = parserConfig.builtin || {};
|
||||
var atoms = parserConfig.atoms || {};
|
||||
|
||||
var isSingleOperatorChar = /[;=\(:\),{}.*<>+\-\/^\[\]]/;
|
||||
var isDoubleOperatorChar = /(:=|<=|>=|==|<>|\.\+|\.\-|\.\*|\.\/|\.\^)/;
|
||||
var isDigit = /[0-9]/;
|
||||
var isNonDigit = /[_a-zA-Z]/;
|
||||
|
||||
function tokenLineComment(stream, state) {
|
||||
stream.skipToEnd();
|
||||
state.tokenize = null;
|
||||
return "comment";
|
||||
}
|
||||
|
||||
function tokenBlockComment(stream, state) {
|
||||
var maybeEnd = false, ch;
|
||||
while (ch = stream.next()) {
|
||||
if (maybeEnd && ch == "/") {
|
||||
state.tokenize = null;
|
||||
break;
|
||||
}
|
||||
maybeEnd = (ch == "*");
|
||||
}
|
||||
return "comment";
|
||||
}
|
||||
|
||||
function tokenString(stream, state) {
|
||||
var escaped = false, ch;
|
||||
while ((ch = stream.next()) != null) {
|
||||
if (ch == '"' && !escaped) {
|
||||
state.tokenize = null;
|
||||
state.sol = false;
|
||||
break;
|
||||
}
|
||||
escaped = !escaped && ch == "\\";
|
||||
}
|
||||
|
||||
return "string";
|
||||
}
|
||||
|
||||
function tokenIdent(stream, state) {
|
||||
stream.eatWhile(isDigit);
|
||||
while (stream.eat(isDigit) || stream.eat(isNonDigit)) { }
|
||||
|
||||
|
||||
var cur = stream.current();
|
||||
|
||||
if(state.sol && (cur == "package" || cur == "model" || cur == "when" || cur == "connector")) state.level++;
|
||||
else if(state.sol && cur == "end" && state.level > 0) state.level--;
|
||||
|
||||
state.tokenize = null;
|
||||
state.sol = false;
|
||||
|
||||
if (keywords.propertyIsEnumerable(cur)) return "keyword";
|
||||
else if (builtin.propertyIsEnumerable(cur)) return "builtin";
|
||||
else if (atoms.propertyIsEnumerable(cur)) return "atom";
|
||||
else return "variable";
|
||||
}
|
||||
|
||||
function tokenQIdent(stream, state) {
|
||||
while (stream.eat(/[^']/)) { }
|
||||
|
||||
state.tokenize = null;
|
||||
state.sol = false;
|
||||
|
||||
if(stream.eat("'"))
|
||||
return "variable";
|
||||
else
|
||||
return "error";
|
||||
}
|
||||
|
||||
function tokenUnsignedNuber(stream, state) {
|
||||
stream.eatWhile(isDigit);
|
||||
if (stream.eat('.')) {
|
||||
stream.eatWhile(isDigit);
|
||||
}
|
||||
if (stream.eat('e') || stream.eat('E')) {
|
||||
if (!stream.eat('-'))
|
||||
stream.eat('+');
|
||||
stream.eatWhile(isDigit);
|
||||
}
|
||||
|
||||
state.tokenize = null;
|
||||
state.sol = false;
|
||||
return "number";
|
||||
}
|
||||
|
||||
// Interface
|
||||
return {
|
||||
startState: function() {
|
||||
return {
|
||||
tokenize: null,
|
||||
level: 0,
|
||||
sol: true
|
||||
};
|
||||
},
|
||||
|
||||
token: function(stream, state) {
|
||||
if(state.tokenize != null) {
|
||||
return state.tokenize(stream, state);
|
||||
}
|
||||
|
||||
if(stream.sol()) {
|
||||
state.sol = true;
|
||||
}
|
||||
|
||||
// WHITESPACE
|
||||
if(stream.eatSpace()) {
|
||||
state.tokenize = null;
|
||||
return null;
|
||||
}
|
||||
|
||||
var ch = stream.next();
|
||||
|
||||
// LINECOMMENT
|
||||
if(ch == '/' && stream.eat('/')) {
|
||||
state.tokenize = tokenLineComment;
|
||||
}
|
||||
// BLOCKCOMMENT
|
||||
else if(ch == '/' && stream.eat('*')) {
|
||||
state.tokenize = tokenBlockComment;
|
||||
}
|
||||
// TWO SYMBOL TOKENS
|
||||
else if(isDoubleOperatorChar.test(ch+stream.peek())) {
|
||||
stream.next();
|
||||
state.tokenize = null;
|
||||
return "operator";
|
||||
}
|
||||
// SINGLE SYMBOL TOKENS
|
||||
else if(isSingleOperatorChar.test(ch)) {
|
||||
state.tokenize = null;
|
||||
return "operator";
|
||||
}
|
||||
// IDENT
|
||||
else if(isNonDigit.test(ch)) {
|
||||
state.tokenize = tokenIdent;
|
||||
}
|
||||
// Q-IDENT
|
||||
else if(ch == "'" && stream.peek() && stream.peek() != "'") {
|
||||
state.tokenize = tokenQIdent;
|
||||
}
|
||||
// STRING
|
||||
else if(ch == '"') {
|
||||
state.tokenize = tokenString;
|
||||
}
|
||||
// UNSIGNED_NUBER
|
||||
else if(isDigit.test(ch)) {
|
||||
state.tokenize = tokenUnsignedNuber;
|
||||
}
|
||||
// ERROR
|
||||
else {
|
||||
state.tokenize = null;
|
||||
return "error";
|
||||
}
|
||||
|
||||
return state.tokenize(stream, state);
|
||||
},
|
||||
|
||||
indent: function(state, textAfter) {
|
||||
if (state.tokenize != null) return CodeMirror.Pass;
|
||||
|
||||
var level = state.level;
|
||||
if(/(algorithm)/.test(textAfter)) level--;
|
||||
if(/(equation)/.test(textAfter)) level--;
|
||||
if(/(initial algorithm)/.test(textAfter)) level--;
|
||||
if(/(initial equation)/.test(textAfter)) level--;
|
||||
if(/(end)/.test(textAfter)) level--;
|
||||
|
||||
if(level > 0)
|
||||
return indentUnit*level;
|
||||
else
|
||||
return 0;
|
||||
},
|
||||
|
||||
blockCommentStart: "/*",
|
||||
blockCommentEnd: "*/",
|
||||
lineComment: "//"
|
||||
};
|
||||
});
|
||||
|
||||
function words(str) {
|
||||
var obj = {}, words = str.split(" ");
|
||||
for (var i=0; i<words.length; ++i)
|
||||
obj[words[i]] = true;
|
||||
return obj;
|
||||
}
|
||||
|
||||
var modelicaKeywords = "algorithm and annotation assert block break class connect connector constant constrainedby der discrete each else elseif elsewhen encapsulated end enumeration equation expandable extends external false final flow for function if import impure in initial inner input loop model not operator or outer output package parameter partial protected public pure record redeclare replaceable return stream then true type when while within";
|
||||
var modelicaBuiltin = "abs acos actualStream asin atan atan2 cardinality ceil cos cosh delay div edge exp floor getInstanceName homotopy inStream integer log log10 mod pre reinit rem semiLinear sign sin sinh spatialDistribution sqrt tan tanh";
|
||||
var modelicaAtoms = "Real Boolean Integer String";
|
||||
|
||||
function def(mimes, mode) {
|
||||
if (typeof mimes == "string")
|
||||
mimes = [mimes];
|
||||
|
||||
var words = [];
|
||||
|
||||
function add(obj) {
|
||||
if (obj)
|
||||
for (var prop in obj)
|
||||
if (obj.hasOwnProperty(prop))
|
||||
words.push(prop);
|
||||
}
|
||||
|
||||
add(mode.keywords);
|
||||
add(mode.builtin);
|
||||
add(mode.atoms);
|
||||
|
||||
if (words.length) {
|
||||
mode.helperType = mimes[0];
|
||||
CodeMirror.registerHelper("hintWords", mimes[0], words);
|
||||
}
|
||||
|
||||
for (var i=0; i<mimes.length; ++i)
|
||||
CodeMirror.defineMIME(mimes[i], mode);
|
||||
}
|
||||
|
||||
def(["text/x-modelica"], {
|
||||
name: "modelica",
|
||||
keywords: words(modelicaKeywords),
|
||||
builtin: words(modelicaBuiltin),
|
||||
atoms: words(modelicaAtoms)
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user