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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
.. _hoc_strfun:
StringFunctions (String Manipulation Class)
-------------------------------------------
.. hoc:class:: StringFunctions
Syntax:
``obj = new StringFunctions()``
Description:
The StringFunctions class contains functions which you can apply to a \ ``strdef``. This class
exists purely for the utility of preventing pollution of name space with string operations.
Example:
.. code-block::
none
objref strobj
strobj = new StringFunctions()
----
.. hoc:method:: StringFunctions.len
Syntax:
``length = strobj.len(str)``
Description:
Return the length of a string.
----
.. hoc:method:: StringFunctions.substr
Syntax:
``index = strobj.substr(s1, s2)``
Description:
Return the index into *s1* of the first occurrence of *s2*.
If *s2* isn't a substring then the return value is -1.
----
.. hoc:method:: StringFunctions.head
Syntax:
``strobj.head(str, "regexp", result)``
Description:
The result contains the head of the string
up to but not including the *regexp*. returns index of
last char.
----
.. hoc:method:: StringFunctions.tail
Syntax:
``strobj.tail(str, "regexp", result)``
Description:
The result contains the tail of the string
from the char following *regexp* to the end of the string.
return index of first char.
Other functions can be added as needed,
eg., \ ``index(s1, c1)``, \ ``char(s1, i)``, etc.
without polluting the global name space. In recent versions
functions can return strings.
----
.. hoc:method:: StringFunctions.right
Syntax:
``strobj.right(str, n)``
Description:
Removes first n characters from *str* and puts the result in
*str*.
----
.. hoc:method:: StringFunctions.left
Syntax:
``.left(str, n)``
Description:
Removes all but first n characters from *str* and puts the
result in *str*
----
.. hoc:method:: StringFunctions.is_name
Syntax:
``.is_name(str)``
Description:
Returns 1 if the *str* is the name of a symbol, 0 otherwise.
This is so useful that the same thing is available with the top level
:hoc:func:`name_declared` function.
----
.. hoc:method:: StringFunctions.alias
Syntax:
``.alias(obj, "name", &var2)``
``.alias(obj, "name", obj2)``
``.alias(obj, "name")``
``.alias(obj)``
Description:
"name" becomes a public variable for obj and points to the
scalar var2 or object obj2. obj.name may be used anywhere the var2 or obj2 may
be used. With no third arg, the "name" is removed from the objects
alias list. With no second arg, the objects alias list is cleared.
----
.. hoc:method:: StringFunctions.alias_list
Syntax:
``list = sf.alias_list(obj)``
Description:
Return a new List object containing String objects which contain
the alias names.
.. warning::
The String class is not a built-in class. It generally gets declared when
the nrngui.hoc file is loaded and lives in stdlib.hoc.
Note that the String class must exist and its
constructor must allow a single strdef argument. Minimally:
.. code-block::
none
begintemplate String
public s
strdef s
proc init() { s = $s1 }
endtemplate String
----
.. hoc:method:: StringFunctions.references
Syntax:
``sf.references(object)``
Description:
Prints the number of references to the object and all objref names
that reference that object (including references via
:hoc:class:`HBox`, :hoc:class:`VBox`, and :hoc:class:`List`). It also prints the number of references found.
----
.. hoc:method:: StringFunctions.is_point_process
Syntax:
``i = sf.is_point_process(object)``
Description:
Returns 0 if the object is not a POINT_PROCESS. Otherwise
returns the point type (which is always 1 greater than the index into the
:hoc:func:`MechanismType(1) <MechanismType>` list).
----
.. hoc:method:: StringFunctions.is_artificial
Syntax:
``i = sf.is_artificial(object)``
Description:
Returns 0 if the object is not an ARTIFICIAL_CELL. Otherwise
returns the point type (which is always 1 greater than the index into the
:hoc:func:`MechanismType(1) <MechanismType>` list).
|
