-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathHelp.js
More file actions
136 lines (117 loc) · 3.41 KB
/
Help.js
File metadata and controls
136 lines (117 loc) · 3.41 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
import { isHelp } from '../utils/is.js'
import { clone } from '../utils/object.js'
import { format } from '../utils/string.js'
import { factory } from '../utils/factory.js'
const name = 'Help'
const dependencies = ['evaluate']
export const createHelpClass = /* #__PURE__ */ factory(name, dependencies, ({ evaluate }) => {
/**
* Documentation object
* @param {Object} doc Object containing properties:
* {string} name
* {string} category
* {string} description
* {string[]} syntax
* {string[]} examples
* {string[]} seealso
* @constructor
*/
function Help (doc) {
if (!(this instanceof Help)) {
throw new SyntaxError('Constructor must be called with the new operator')
}
if (!doc) throw new Error('Argument "doc" missing')
this.doc = doc
}
/**
* Attach type information
*/
Help.prototype.type = 'Help'
Help.prototype.isHelp = true
/**
* Generate a string representation of the Help object
* @return {string} Returns a string
* @private
*/
Help.prototype.toString = function () {
const doc = this.doc || {}
let desc = '\n'
if (doc.name) {
desc += 'Name: ' + doc.name + '\n\n'
}
if (doc.category) {
desc += 'Category: ' + doc.category + '\n\n'
}
if (doc.description) {
desc += 'Description:\n ' + doc.description + '\n\n'
}
if (doc.syntax) {
desc += 'Syntax:\n ' + doc.syntax.join('\n ') + '\n\n'
}
if (doc.examples) {
desc += 'Examples:\n'
// after evaluating the examples, we restore config in case the examples
// did change the config.
let configChanged = false
const originalConfig = evaluate('config()')
const scope = {
config: (newConfig) => {
configChanged = true
return evaluate('config(newConfig)', { newConfig })
}
}
for (let i = 0; i < doc.examples.length; i++) {
const expr = doc.examples[i]
desc += ' ' + expr + '\n'
let res
try {
// note: res can be undefined when `expr` is an empty string
res = evaluate(expr, scope)
} catch (e) {
res = e
}
if (res !== undefined && !isHelp(res)) {
desc += ' ' + format(res, { precision: 14 }) + '\n'
}
}
desc += '\n'
if (configChanged) {
evaluate('config(originalConfig)', { originalConfig })
}
}
if (doc.mayThrow && doc.mayThrow.length) {
desc += 'Throws: ' + doc.mayThrow.join(', ') + '\n\n'
}
if (doc.seealso && doc.seealso.length) {
desc += 'See also: ' + doc.seealso.join(', ') + '\n'
}
return desc
}
/**
* Export the help object to JSON
*/
Help.prototype.toJSON = function () {
const obj = clone(this.doc)
obj.mathjs = 'Help'
return obj
}
/**
* Instantiate a Help object from a JSON object
* @param {Object} json
* @returns {Help} Returns a new Help object
*/
Help.fromJSON = function (json) {
const doc = {}
Object.keys(json)
.filter(prop => prop !== 'mathjs')
.forEach(prop => {
doc[prop] = json[prop]
})
return new Help(doc)
}
/**
* Returns a string representation of the Help object
*/
Help.prototype.valueOf = Help.prototype.toString
return Help
}, { isClass: true })