---

General interface to obtain information from XOTcl/NX objects and classes for the API browser.

Defined in packages/xotcl-core/tcl/01-debug-procs.tcl

Class Relations

• class: ::nx::Object

Methods (to be applied on the object)

• debug_widget (scripted, public)

   xo::api debug_widget proc_spec

  Return HTML code for a debug switch that lets an admin turn debugging of functions and methods on and off. This functionality is only allowed to site-wide admins.

  Parameters:

  proc_spec (required)

  Testcases:

  No testcase defined.

• get_doc_block (scripted, public)

   xo::api get_doc_block text [ restVar ]

  Get the (first) documentation block of the provided text (which might be e.g. the body of a method).

  Parameters:

  text (required)

  restVar (optional)

  Testcases:

  No testcase defined.

• get_init_block (scripted, public)

   xo::api get_init_block scope obj

  Get the init block of an object/class or return empty

  Parameters:

  scope (required)

  obj (required)

  Testcases:

  No testcase defined.

• get_method_body (scripted, public)

   xo::api get_method_body scope obj prefix method

  Return the method body on object (when "prefix" is empty) or class (when "prefix" is "inst").

  Parameters:

  scope (required)

  obj (required)

  prefix (required)

  method (required)

  Testcases:

  No testcase defined.

• get_method_source (scripted, public)

   xo::api get_method_source scope obj prefix method

  Return the full method definition.

  Parameters:

  scope (required)

  obj (required)

  prefix (required)

  method (required)

  Testcases:

  No testcase defined.

• get_object_source (scripted, public)

   xo::api get_object_source scope obj

  Return the full object definition

  Parameters:

  scope (required)

  obj (required)

  Testcases:

  No testcase defined.

• get_proc_definition_flags (scripted, public)

   xo::api get_proc_definition_flags debug deprecated

  Helper for version compatibility

  Parameters:

  debug (required)

  deprecated (required)

  Returns:

  flags for proc definition

  Testcases:

  No testcase defined.

• get_returns_spec (scripted, public)

   xo::api get_returns_spec returns

  Helper for version compatibility

  Parameters:

  returns (required)

  Returns:

  flags for -returns flag

  Testcases:

  No testcase defined.

• isclass (scripted, public)

   xo::api isclass scope obj

  Check, whether the passed in obj is a class

  Parameters:

  scope (required)

  obj (required)

  Testcases:

  No testcase defined.

• isobject (scripted, public)

   xo::api isobject scope obj

  Check, whether the passed in obj is an object

  Parameters:

  scope (required)

  obj (required)

  Testcases:

  No testcase defined.

• method_label (scripted, public)

   xo::api method_label [ -kind ] proc_spec

  Return a user-friendly label for methods and objects.

  Switches:

  -kind (optional)

  when set, use naming convention from nx, otherwise XOTcl

  Parameters:

  proc_spec (required)

  Testcases:

  No testcase defined.

• method_link (scripted, public)

   xo::api method_link [ -label label ] obj kind method

  Return a link for the method if possible. If no proc-doc is available, return just plain text.

  Switches:

  -label (optional)

  Parameters:

  obj (required)

  kind (required)

  method (required)

  Testcases:

  No testcase defined.

• object_from_proc_index (scripted, public)

   xo::api object_from_proc_index proc_index

  Parse the proc_index and return the scope from it.

  Parameters:

  proc_index (required)

  Testcases:

  No testcase defined.

• object_index (scripted, public)

   xo::api object_index scope obj

  Return a canonical index string for the object

  Parameters:

  scope (required)

  obj (required)

  Testcases:

  No testcase defined.

• object_link (scripted, public)

   xo::api object_link [ -noimg on|off ] scope obj

  Return a link for the object.

  Switches:

  -noimg (optional, boolean, defaults to "off")

  Parameters:

  scope (required)

  obj (required)

  Testcases:

  No testcase defined.

• object_url (scripted, public)

   xo::api object_url [ -show_source show_source ] \
      [ -show_methods show_methods ] scope obj

  Return a link for the object in the object browser (show-object)

  Switches:

  -show_source (optional, defaults to "0")

  -show_methods (optional, defaults to "1")

  Parameters:

  scope (required)

  obj (required)

  Testcases:

  No testcase defined.

• proc_index (scripted, public)

   xo::api proc_index scope obj instproc proc_name

  Return a canonical index string for the specified method

  Parameters:

  scope (required)

  obj (required)

  instproc (required)

  proc_name (required)

  Testcases:

  No testcase defined.

• scope (scripted, public)

   xo::api scope

  Return the scope of the object. When executed in an XOTcl thread; the body won't be accessible by default without the explicit scope. The purpose of this proc is to document objects and classes that live only in a certain thread.

  Testcases:

  No testcase defined.

• scope_eval (scripted, public)

   xo::api scope_eval scope args [ args... ]

  When the scope is not empty, evaluate the command in the specified scope (thread)

  Parameters:

  scope (required)

  args (required)

  Testcases:

  No testcase defined.

• scope_from_object_reference (scripted, public)

   xo::api scope_from_object_reference scope_var object_var

  Parse the object reference and return the scope from it.

  Parameters:

  scope_var (required)

  object_var (required)

  Testcases:

  No testcase defined.

• scope_from_proc_index (scripted, public)

   xo::api scope_from_proc_index proc_index

  Parse the proc_index and return the scope from it.

  Parameters:

  proc_index (required)

  Testcases:

  No testcase defined.

• script_name (scripted, public)

   xo::api script_name [ -obj obj ] scope

  Determine name of the current "script" as displayed by "Defined in" in the API browser. Define different sources available in different situatons.

  Switches:

  -obj (optional)

  class name for identifying the source filename

  Parameters:

  scope (required)

  either empty or thread name

  Returns:

  path starting with the "packages" directory

  Testcases:

  No testcase defined.

• source_to_html (scripted, public)

   xo::api source_to_html [ -width width ] string

  Helper proc to preserve indentation in source-code to HTML conversion.

  Switches:

  -width (optional, defaults to "100")

  Parameters:

  string (required)

  Testcases:

  No testcase defined.

• update_method_doc (scripted, public)

   xo::api update_method_doc [ -protection protection ] [ -deprecated ] \
      [ -debug ] [ -warn ] scope obj inst proc_name docString

  Obtain a doc-string for a method, convert it and add it to the proc-doc.

  Switches:

  -protection (optional, defaults to "public")

  -deprecated (optional, defaults to "false")

  -debug (optional, defaults to "false")

  -warn (optional, defaults to "false")

  Parameters:

  scope (required)

  obj (required)

  inst (required)

  proc_name (required)

  docString (required)

  Testcases:

  No testcase defined.

• update_nx_docs (scripted, public)

   xo::api update_nx_docs [ objects ]

  Update for the provided (or all) nx::Object instances the internal documentation structures.

  Parameters:

  objects (optional)

  Testcases:

  No testcase defined.

• update_object_doc (scripted, public)

   xo::api update_object_doc scope obj doc_string

  Update the API browser nsvs with information about the provided object. If no doc string is provided, try to get it from the object definition. if {![string match ::* $obj]} { ad_log error "==== update_object_doc OBJECT WITHOUT leading colons <$obj>" }

  Parameters:

  scope (required)

  obj (required)

  doc_string (required)

  Testcases:

  No testcase defined.

---