File: verbatim.rst

package info (click to toggle)
neuron 8.2.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 34,760 kB
  • sloc: cpp: 149,571; python: 58,465; ansic: 50,329; sh: 3,510; xml: 213; pascal: 51; makefile: 35; sed: 5
file content (57 lines) | stat: -rw-r--r-- 1,901 bytes parent folder | download | duplicates (3)
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
Verbatim
~~~~~~~~

Description:
    Sections of code surrounded by ``VERBATIM`` and ``ENDVERBATIM`` blocks are
    interpreted as literal C/C++ code.
    This feature is typically used to interface with external C/C++ libraries,
    or to use NEURON features (such as random number generation) that are not
    explicitly supported in the NMODL language.

    .. code-block::

      PROCEDURE set_foo() {
      VERBATIM
      /* literal C/C++ */
      ENDVERBATIM
        foo = 42
      }

    This is, by its nature, more fragile than exclusively using NMODL language
    constructs, but it can be necessary.
    NEURON versions newer than 8.1
    (`#1762 <https://github.com/neuronsimulator/nrn/pull/1762>`_) provide some
    C/C++ preprocessor macros that make it easier to follow incompatible changes
    in external libraries or the internal workings of NEURON.

    .. code-block:: c++

      #if NRN_VERSION_EQ(9, 0, 0)
      /* NEURON version is exactly 9.0.0 */
      #endif
      #if NRN_VERSION_NE(8, 2, 3)
      /* NEURON version is not 8.2.3 */
      #endif
      #if NRN_VERSION_GT(9, 1, 0)
      /* NEURON version is >9.1.0 */
      #endif
      #if NRN_VERSION_LT(10, 2, 0)
      /* NEURON version is <10.2.0 */
      #endif
      #if NRN_VERSION_GTEQ(8, 2, 1)
      /* NEURON version is >=8.2.1 */
      #endif
      #if NRN_VERSION_LTEQ(8, 2, 2)
      /* NEURON version is <=8.2.2 */
      #endif
      #ifndef NRN_VERSION_GTEQ_8_2_0
      /* NEURON version is <8.2.0 */
      #else
      /* NEURON version is >=8.2.0 so NRN_VERSION_{EQ,NE,GT,LT,GTEQ,LTEQ}(...)
       * are defined. */
      #endif

    ``VERBATIM`` should be used with caution and restraint, as it is very easy
    to introduce dependencies on the implementation details of NEURON and the
    NMODL language compilers and end up with MOD files that are only compatible
    with a limited range of NEURON versions.