HelpSource/Classes/FunctionDef.schelp

   1 class::FunctionDef
   2 summary:: FunctionDefs contain code which can be executed from a Function.
   3 categories::Core>Kernel
   4
   5 instanceMethods::
   6
   7 subsection::Accessing
   8
   9 Even though it is possible to change the values in the various arrays that define the FunctionDef,
  10 you should not do it, unless you like to crash.
  11
  12 method::code
  13
  14 Get the byte code array.
  15
  16 code::
  17 { |a = 9, b = 10, c| a + b }.def.code;
  18 ::
  19
  20 method::sourceCode
  21
  22 Get the source code string.
  23 code::
  24 { |a = 9, b = 10, c| a + b }.def.sourceCode.postcs;
  25 ::
  26
  27 method::context
  28
  29 Get the enclosing FunctionDef or Method.
  30
  31 method::findReferences
  32
  33 return a list of all references to a given symbol.
  34
  35 method::argNames
  36
  37 Get the Array of Symbols of the argument names.
  38
  39 code::
  40 { |a = 9, b = 10, c| a + b }.def.argNames;
  41 ::
  42 method::prototypeFrame
  43
  44 Get the array of default values for argument and temporary variables.
  45
  46 code::
  47 { |a = 9, b = 10, c| a + b }.def.prototypeFrame;
  48 ::
  49 method::varNames
  50
  51 Get the Array of Symbols of the local variable names.
  52
  53 code::
  54 { |a = 9, b = 10, c| var x = 9; a + b + x }.def.varNames;
  55 ::
  56 method::argumentString
  57
  58 Return a string that contains  arguments and their default values for embedding in a string
  59
  60 code::
  61 { |a = 9, b = 10, c| a + b }.def.argumentString;
  62 ::
  63
  64 method::makeEnvirFromArgs
  65
  66 Get the Array of Symbols of the local variable names.
  67
  68 code::
  69 { |a = 9, b = 10, c| a + b }.def.makeEnvirFromArgs;
  70 ::
  71
  72 subsection::Utilities
  73
  74 method::dumpByteCodes
  75
  76 "Disassemble" and post the FunctionDef's byte code instructions to the text window.
  77
  78