ed81751999-12-11Martin Stjernholm //! RXML parser and compiler framework. //! //! Created 1999-07-30 by Martin Stjernholm. //!
0f998b2000-08-15Martin Stjernholm //! $Id: module.pmod,v 1.101 2000/08/15 01:25:33 mast Exp $
ed81751999-12-11Martin Stjernholm  //! Kludge: Must use "RXML.refs" somewhere for the whole module to be //! loaded correctly.
6c902e2000-03-17Martin Stjernholm static object Roxen;
4becf22000-03-19Martin Nilsson class RequestID { };
ed81751999-12-11Martin Stjernholm 
8cb24d2000-02-13Martin Stjernholm //! WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING //! WARNING WARNING //! WARNING This API is not yet set in stone. WARNING //! WARNING Expect incompatible changes. WARNING //! WARNING WARNING //! WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
ed81751999-12-11Martin Stjernholm 
d8769c2000-02-08Martin Stjernholm //#pragma strict_types // Disabled for now since it doesn't work well enough.
ed81751999-12-11Martin Stjernholm 
cd7d5f2000-02-16Martin Stjernholm #include <config.h>
b483382000-06-30Martin Stjernholm #include <request_trace.h>
ed81751999-12-11Martin Stjernholm 
ec027c2000-03-16Martin Stjernholm #ifdef RXML_OBJ_DEBUG
f02d002000-03-18Martin Stjernholm # define MARK_OBJECT \ Debug.ObjectMarker __object_marker = Debug.ObjectMarker (this_object()) # define MARK_OBJECT_ONLY \ Debug.ObjectMarker __object_marker = Debug.ObjectMarker (0)
ec027c2000-03-16Martin Stjernholm #else
f02d002000-03-18Martin Stjernholm # define MARK_OBJECT # define MARK_OBJECT_ONLY
ec027c2000-03-16Martin Stjernholm #endif
26ff092000-01-21Martin Stjernholm #ifdef OBJ_COUNT_DEBUG // This debug mode gives every object a unique number in the // _sprintf() string.
f02d002000-03-18Martin Stjernholm # ifndef RXML_OBJ_DEBUG # undef MARK_OBJECT # undef MARK_OBJECT_ONLY # define MARK_OBJECT \ mapping __object_marker = (["count": ++all_constants()->_obj_count]) # define MARK_OBJECT_ONLY \ mapping __object_marker = (["count": ++all_constants()->_obj_count]) # endif # define OBJ_COUNT (__object_marker ? "[" + __object_marker->count + "]" : "")
26ff092000-01-21Martin Stjernholm #else
f02d002000-03-18Martin Stjernholm # define OBJ_COUNT ""
26ff092000-01-21Martin Stjernholm #endif
f02d002000-03-18Martin Stjernholm #define HASH_INT2(m, n) (n < 65536 ? (m << 16) + n : sprintf ("%x,%x", m, n))
23a0882000-08-12Martin Stjernholm 
ed81751999-12-11Martin Stjernholm class Tag //! Interface class for the static information about a tag. {
cece9e2000-01-11Martin Stjernholm  constant is_RXML_Tag = 1;
ed81751999-12-11Martin Stjernholm  //! Interface. //!string name; //! The name of the tag. Required and considered constant.
f585722000-01-18Martin Stjernholm  /*extern*/ int flags;
ed81751999-12-11Martin Stjernholm  //! Various bit flags that affect parsing; see the FLAG_* constants. //! RXML.Frame.flags is initialized from this.
710b482000-02-07Martin Stjernholm  mapping(string:Type) req_arg_types = ([]); mapping(string:Type) opt_arg_types = ([]); //! The names and types of the required and optional arguments. If a //! type specifies a parser, it'll be used on the argument value. //! Note that the order in which arguments are parsed is arbitrary.
ed81751999-12-11Martin Stjernholm 
3187d82000-01-28Martin Stjernholm  Type def_arg_type = t_text (PEnt); //! The type used for arguments that isn't present in neither //! req_arg_types nor opt_arg_types. This default is a parser that
8cb24d2000-02-13Martin Stjernholm  //! only parses XML-style entities.
3187d82000-01-28Martin Stjernholm 
8cb24d2000-02-13Martin Stjernholm  Type content_type = t_same (PXml);
590b3c2000-02-05Martin Stjernholm  //! The handled type of the content, if the tag gets any.
ed81751999-12-11Martin Stjernholm  //!
590b3c2000-02-05Martin Stjernholm  //! This default is the special type t_same, which means the type is
8cb24d2000-02-13Martin Stjernholm  //! taken from the effective type of the result. The PXml argument //! causes the standard XML parser to be used to read it, which //! means that the content is preparsed with XML syntax. Use no //! parser to get the raw text.
24f9e82000-08-05Martin Stjernholm  //! //! Note: You probably want to change this to t_text (without //! parser) if the tag is a processing instruction (see //! FLAG_PROC_INSTR).
ed81751999-12-11Martin Stjernholm 
590b3c2000-02-05Martin Stjernholm  array(Type) result_types = ({t_xml, t_html, t_text});
c6245b1999-12-31Martin Stjernholm  //! The possible types of the result, in order of precedence. If a
91c8982000-03-11Martin Stjernholm  //! result type has a parser, it'll be used to parse any strings in //! the exec array returned from Frame.do_enter() and similar //! callbacks.
46c68f2000-08-12Martin Stjernholm  //! //! When the tag is used in content of some type, it suffices that //! the content type is a subtype of any type in result_types. The //! tag must therefore be prepared to produce result of more //! specific types than those declared here. I.e. the extreme case, //! t_any, means that this tag takes the responsibility to produce //! result of any type that's asked for, not that it has the liberty //! to produce results of any type it chooses.
ed81751999-12-11Martin Stjernholm 
c159ec2000-02-04Martin Stjernholm  //!program Frame; //!object(Frame) Frame(); //! This program/function is used to clone the objects used as //! frames. A frame object must (in practice) inherit RXML.Frame. //! (It can, of course, be any function that requires no arguments //! and returns a new frame object.) This is not used for plugin //! tags. //!string plugin_name; //! If this is defined, this is a so-called plugin tag. That means //! it plugs in some sort of functionality in another Tag object //! instead of handling the actual tags of its own. It works as //! follows: //! //! o Instead of installing the callbacks for this tag, the parser //! uses another registered "socket" Tag object that got the same //! name as this one. Socket tags have the FLAG_SOCKET_TAG flag //! set to signify that they accept plugins. //!
cf3c902000-02-04Martin Stjernholm  //! o When the socket tag is parsed or evaluated, it can get the //! Tag objects for the registered plugins with the function //! Frame.get_plugins(). It's then up to the socket tag to use //! the plugins according to some API it defines.
c159ec2000-02-04Martin Stjernholm  //! //! o plugin_name is the name of the plugin. It's used as index in
cf3c902000-02-04Martin Stjernholm  //! the mapping that the Frame.get_plugins() returns.
c159ec2000-02-04Martin Stjernholm  //! //! o The plugin tag is registered in the tag set with the //! identifier //! //! name + "#" + plugin_name //! //! It overrides other plugin tags with that name according to //! the normal tag set rules, but, as said above, is never //! registered for actual parsing at all. //! //! It's undefined whether plugin tags override normal tags -- //! '#' should never be used in normal tag names. //! //! o It's not an error to register a plugin for which there is no //! socket. Such plugins are simply ignored.
ed81751999-12-11Martin Stjernholm  //! Services.
cf3c902000-02-04Martin Stjernholm  inline object/*(Frame)HMM*/ `() (mapping(string:mixed) args, void|mixed content)
ed81751999-12-11Martin Stjernholm  //! Make an initialized frame for the tag. Typically useful when
91c8982000-03-11Martin Stjernholm  //! returning generated tags from e.g. RXML.Frame.do_process(). The
cf3c902000-02-04Martin Stjernholm  //! argument values and the content are normally not parsed.
ed81751999-12-11Martin Stjernholm  {
56532d1999-12-19Martin Stjernholm  Tag this = this_object();
cf3c902000-02-04Martin Stjernholm  object/*(Frame)HMM*/ frame = ([function(:object/*(Frame)HMM*/)] this->Frame)();
ed81751999-12-11Martin Stjernholm  frame->tag = this; frame->flags = flags; frame->args = args;
23a0882000-08-12Martin Stjernholm  frame->content = zero_type (content) ? nil : content; frame->result = nil;
ed81751999-12-11Martin Stjernholm  return frame; }
c159ec2000-02-04Martin Stjernholm  int eval_args (mapping(string:mixed) args, void|int dont_throw, void|Context ctx) //! Parses and evaluates the tag arguments according to //! req_arg_types and opt_arg_types. The args mapping contains the //! unparsed arguments on entry, and they get replaced by the parsed //! results. Arguments not mentioned in req_arg_types or //! opt_arg_types are not touched. RXML errors, such as missing //! argument, are thrown if dont_throw is zero or left out, //! otherwise zero is returned for such errors. ctx specifies the //! context to use; it defaults to the current context. { // Note: Code duplication in Frame._eval().
710b482000-02-07Martin Stjernholm  mapping(string:Type) atypes = args & req_arg_types; if (sizeof (atypes) < sizeof (req_arg_types)) if (dont_throw) return 0; else { array(string) missing = sort (indices (req_arg_types - atypes));
5ed0132000-02-13Martin Stjernholm  parse_error ("Required " + (sizeof (missing) > 1 ? "arguments " + String.implode_nicely (missing) + " are" : "argument " + missing[0] + " is") + " missing.\n");
710b482000-02-07Martin Stjernholm  } atypes += args & opt_arg_types;
c159ec2000-02-04Martin Stjernholm #ifdef MODULE_DEBUG
710b482000-02-07Martin Stjernholm  if (mixed err = catch {
c159ec2000-02-04Martin Stjernholm #endif
710b482000-02-07Martin Stjernholm  foreach (indices (atypes), string arg) args[arg] = atypes[arg]->eval (args[arg], ctx); // Should not unwind.
c159ec2000-02-04Martin Stjernholm #ifdef MODULE_DEBUG
710b482000-02-07Martin Stjernholm  }) { if (objectp (err) && ([object] err)->thrown_at_unwind)
8cb24d2000-02-13Martin Stjernholm  fatal_error ("Can't save parser state when evaluating arguments.\n"); throw_fatal (err);
c159ec2000-02-04Martin Stjernholm  }
710b482000-02-07Martin Stjernholm #endif
c159ec2000-02-04Martin Stjernholm  return 1; }
ed81751999-12-11Martin Stjernholm  // Internals.
01e43b2000-01-14Martin Stjernholm  array _handle_tag (TagSetParser parser, mapping(string:string) args,
c6245b1999-12-31Martin Stjernholm  void|string content)
24f9e82000-08-05Martin Stjernholm  // Callback for tag set parsers to handle non-PI tags. Returns a // sequence of result values to be added to the result queue. Note // that this function handles an unwind frame for the parser.
ed81751999-12-11Martin Stjernholm  {
24f9e82000-08-05Martin Stjernholm  // Note: args may be zero since this is called from _handle_pi_tag().
56532d1999-12-19Martin Stjernholm  Context ctx = parser->context;
ed81751999-12-11Martin Stjernholm  // FIXME: P-code generation.
9d80e82000-02-11Martin Stjernholm 
51f88b2000-06-23Martin Stjernholm  string splice_args;
24f9e82000-08-05Martin Stjernholm  if (args && (splice_args = args["::"])) {
9d80e82000-02-11Martin Stjernholm  // Somewhat kludgy solution for the time being.
51f88b2000-06-23Martin Stjernholm #ifdef MODULE_DEBUG if (mixed err = catch { #endif splice_args = t_text (PEnt)->eval (splice_args, ctx, 0, parser, 1); #ifdef MODULE_DEBUG }) { if (objectp (err) && ([object] err)->thrown_at_unwind) fatal_error ("Can't save parser state when evaluating splice argument.\n"); throw_fatal (err); } #endif
9d80e82000-02-11Martin Stjernholm  m_delete (args, "::"); args += parser->parse_tag_args (splice_args); }
f997202000-01-18Martin Stjernholm  object/*(Frame)HMM*/ frame;
56532d1999-12-19Martin Stjernholm  if (mapping(string:mixed)|mapping(object:array) ustate = ctx->unwind_state)
26ff092000-01-21Martin Stjernholm  if (ustate[parser]) { frame = [object/*(Frame)HMM*/] ustate[parser][0]; m_delete (ustate, parser); if (!sizeof (ustate)) ctx->unwind_state = 0; }
46c68f2000-08-12Martin Stjernholm  else frame = `() (args, nil); else frame = `() (args, nil);
56532d1999-12-19Martin Stjernholm 
9a38062000-08-04Martin Stjernholm  if (!zero_type (frame->raw_tag_text)) {
51f88b2000-06-23Martin Stjernholm  if (splice_args) frame->raw_tag_text =
9a38062000-08-04Martin Stjernholm  t_xml->format_tag (parser->tag_name(), args, content, flags | FLAG_RAW_ARGS);
51f88b2000-06-23Martin Stjernholm  else frame->raw_tag_text = parser->current_input();
9a38062000-08-04Martin Stjernholm  }
51f88b2000-06-23Martin Stjernholm 
56532d1999-12-19Martin Stjernholm  mixed err = catch { frame->_eval (parser, args, content);
590b3c2000-02-05Martin Stjernholm  mixed res;
46c68f2000-08-12Martin Stjernholm  if ((res = frame->result) == nil) return ({});
23a0882000-08-12Martin Stjernholm  if (frame->result_type->encoding_type ? frame->result_type->encoding_type != parser->type->encoding_type : frame->result_type != parser->type) res = parser->type->encode (res, frame->result_type);
590b3c2000-02-05Martin Stjernholm  return ({res});
56532d1999-12-19Martin Stjernholm  }; if (objectp (err) && ([object] err)->thrown_at_unwind) { mapping(string:mixed)|mapping(object:array) ustate = ctx->unwind_state; if (!ustate) ustate = ctx->unwind_state = ([]); #ifdef DEBUG if (err != frame)
8cb24d2000-02-13Martin Stjernholm  fatal_error ("Internal error: Unexpected unwind object catched.\n");
56532d1999-12-19Martin Stjernholm  if (ustate[parser])
8cb24d2000-02-13Martin Stjernholm  fatal_error ("Internal error: Clobbering unwind state for parser.\n");
56532d1999-12-19Martin Stjernholm #endif ustate[parser] = ({err});
8cb24d2000-02-13Martin Stjernholm  throw (err = parser);
56532d1999-12-19Martin Stjernholm  }
f0ce412000-03-06Martin Stjernholm  else { ctx->handle_exception (err, parser); // Will rethrow unknown errors. return ({}); }
ed81751999-12-11Martin Stjernholm  }
24f9e82000-08-05Martin Stjernholm  array _handle_pi_tag (TagSetParser parser, string content) // Callback similar to _handle_tag() for tag set parsers to handle // PI tags. {
46c68f2000-08-12Martin Stjernholm  sscanf (content, "%[ \t\n\r]%s", string ws, string rest); if (ws == "" && rest != "")
24f9e82000-08-05Martin Stjernholm  // The parser didn't match a complete name, so this is a false // alarm for an unknown PI tag. return 0; return _handle_tag (parser, 0, content); }
87fb7e2000-03-25Martin Stjernholm  /* Can't define `== here due to Pike bugs.. int __hash() { return hash (this_object()->name); } int `== (mixed other) { return objectp (other) && other->is_RXML_Tag && other->name == this_object()->name; } */
f02d002000-03-18Martin Stjernholm  MARK_OBJECT;
26ff092000-01-21Martin Stjernholm 
ed81751999-12-11Martin Stjernholm  string _sprintf() {
24f9e82000-08-05Martin Stjernholm  return "RXML.Tag(" + [string] this_object()->name + (this_object()->plugin_name ? "#" + [string] this_object()->plugin_name : "") + ([int] this_object()->flags & FLAG_PROC_INSTR ? " [PI]" : "") + ")" + OBJ_COUNT;
ed81751999-12-11Martin Stjernholm  } } class TagSet //! Contains a set of tags. Tag sets can import other tag sets, and //! later changes are propagated. Parser instances (contexts) to parse
2bd21a2000-01-05Martin Stjernholm //! data are created from this. TagSet objects may somewhat safely be //! destructed explicitly; the tags in a destructed tag set will not //! be active in parsers that are instantiated later, but will work in
24f9e82000-08-05Martin Stjernholm //! current instances. Element (i.e. non-PI) tags and PI tags have //! separate namespaces. //! //! Note: A Tag object may not be registered in more than one tag set //! at the same time.
ed81751999-12-11Martin Stjernholm {
2bd21a2000-01-05Martin Stjernholm  string name; //! Used for identification only.
ed81751999-12-11Martin Stjernholm  string prefix;
f997202000-01-18Martin Stjernholm  //! A namespace prefix that may precede the tags. If it's zero, it's //! up to the importing tag set(s). A ':' is always inserted between //! the prefix and the tag name.
ed81751999-12-11Martin Stjernholm 
f997202000-01-18Martin Stjernholm  int prefix_req;
ed81751999-12-11Martin Stjernholm  //! The prefix must precede the tags. array(TagSet) imported = ({}); //! Other tag sets that will be used. The precedence is local tags //! first, then imported from left to right. It's not safe to //! destructively change entries in this array.
660cb52000-01-12Martin Stjernholm  function(Context:void) prepare_context; //! If set, this is a function that will be called before a new //! Context object is taken into use. It'll typically prepare //! predefined scopes and variables. The functions will be called in //! order of precedence; highest last.
ed81751999-12-11Martin Stjernholm  int generation = 1; //! A number that is increased every time something changes in this //! object or in some tag set it imports.
f02d002000-03-18Martin Stjernholm  int id_number; //! Unique number identifying this tag set.
2bd21a2000-01-05Martin Stjernholm  static void create (string _name, void|array(Tag) _tags)
ed81751999-12-11Martin Stjernholm  //! {
f02d002000-03-18Martin Stjernholm  id_number = ++tag_set_count;
2bd21a2000-01-05Martin Stjernholm  name = _name;
24f9e82000-08-05Martin Stjernholm  if (_tags) add_tags (_tags);
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG __object_marker->create (this_object()); #endif
ed81751999-12-11Martin Stjernholm  } void add_tag (Tag tag) //! {
24f9e82000-08-05Martin Stjernholm  if (tag->flags & FLAG_PROC_INSTR) { if (!proc_instrs) proc_instrs = ([]); if (tag->plugin_name) proc_instrs[tag->name + "#" + tag->plugin_name] = tag; else proc_instrs[tag->name] = tag; } else if (tag->plugin_name) tags[tag->name + "#" + tag->plugin_name] = tag; else tags[tag->name] = tag;
ed81751999-12-11Martin Stjernholm  changed(); } void add_tags (array(Tag) _tags) //! {
24f9e82000-08-05Martin Stjernholm  foreach (_tags, Tag tag) { if (tag->flags & FLAG_PROC_INSTR) { if (!proc_instrs) proc_instrs = ([]); if (tag->plugin_name) proc_instrs[tag->name + "#" + tag->plugin_name] = tag; else proc_instrs[tag->name] = tag; } else if (tag->plugin_name) tags[tag->name + "#" + tag->plugin_name] = tag; else tags[tag->name] = tag; }
ed81751999-12-11Martin Stjernholm  changed(); }
24f9e82000-08-05Martin Stjernholm  void remove_tag (string|Tag tag, void|int proc_instr) //! If tag is a Tag object, it's removed if this tag set contains //! it. If tag is a string, the tag with that name is removed. In //! the latter case, if proc_instr is nonzero the set of PI tags is //! searched, else the set of normal element tags.
ed81751999-12-11Martin Stjernholm  { if (stringp (tag))
24f9e82000-08-05Martin Stjernholm  if (proc_instr) { if (proc_instrs) m_delete (proc_instrs, tag); } else m_delete (tags, tag); else { string n; if (tag->flags & FLAG_PROC_INSTR) { if (proc_instrs && !zero_type (n = search (tags, [object(Tag)] tag))) m_delete (proc_instrs, n); } else if (!zero_type (n = search (tags, [object(Tag)] tag))) m_delete (tags, n); }
ed81751999-12-11Martin Stjernholm  changed(); }
24f9e82000-08-05Martin Stjernholm  local Tag get_local_tag (string name, void|int proc_instr) //! Returns the Tag object for the given name in this tag set, if //! any. If proc_instr is nonzero the set of PI tags is searched, //! else the set of normal element tags.
ed81751999-12-11Martin Stjernholm  {
24f9e82000-08-05Martin Stjernholm  return proc_instr ? proc_instrs && proc_instrs[name] : tags[name];
ed81751999-12-11Martin Stjernholm  } array(Tag) get_local_tags()
24f9e82000-08-05Martin Stjernholm  //! Returns all the Tag objects in this tag set.
ed81751999-12-11Martin Stjernholm  {
24f9e82000-08-05Martin Stjernholm  array(Tag) res = values (tags); if (proc_instrs) res += values (proc_instrs); return res;
ed81751999-12-11Martin Stjernholm  }
24f9e82000-08-05Martin Stjernholm  Tag get_tag (string name, void|int proc_instr) //! Returns the Tag object for the given name, if any, that's //! defined by this tag set (including its imported tag sets). If //! proc_instr is nonzero the set of PI tags is searched, else the //! set of normal element tags.
2bd21a2000-01-05Martin Stjernholm  {
24f9e82000-08-05Martin Stjernholm  if (object(Tag) def = get_local_tag (name, proc_instr))
56ffee2000-01-12Martin Stjernholm  return def; foreach (imported, TagSet tag_set)
24f9e82000-08-05Martin Stjernholm  if (object(Tag) tag = [object(Tag)] tag_set->get_tag (name, proc_instr)) return tag;
56ffee2000-01-12Martin Stjernholm  return 0;
da54bd2000-01-08Martin Stjernholm  }
24f9e82000-08-05Martin Stjernholm  multiset(string) get_tag_names() //! Returns the names of all non-PI tags that this tag set defines. { return `| ((multiset) indices (tags), @imported->get_tag_names()); } multiset(string) get_proc_instr_names() //! Returns the names of all PI tags that this tag set defines. { return `| (proc_instrs ? (multiset) indices (proc_instrs) : (<>), @imported->get_proc_instr_names()); }
2e0a6d2000-07-06Martin Stjernholm  Tag get_overridden_tag (Tag overrider)
56ffee2000-01-12Martin Stjernholm  //! Returns the tag definition that the given one overrides, or zero
2e0a6d2000-07-06Martin Stjernholm  //! if none.
da54bd2000-01-08Martin Stjernholm  {
51f88b2000-06-23Martin Stjernholm  if (!mappingp (overridden_tag_lookup)) overridden_tag_lookup = set_weak_flag (([]), 1);
2e0a6d2000-07-06Martin Stjernholm  Tag tag; if (zero_type (tag = overridden_tag_lookup[overrider])) tag = overridden_tag_lookup[overrider] =
24f9e82000-08-05Martin Stjernholm  overrider->flags & FLAG_PROC_INSTR ? find_overridden_proc_instr (overrider) :
2e0a6d2000-07-06Martin Stjernholm  find_overridden_tag (overrider);
51f88b2000-06-23Martin Stjernholm  return tag;
2bd21a2000-01-05Martin Stjernholm  }
24f9e82000-08-05Martin Stjernholm  array(Tag) get_overridden_tags (string name, void|int proc_instr)
56ffee2000-01-12Martin Stjernholm  //! Returns all tag definitions for the given name, i.e. including //! the overridden ones. A tag to the left overrides one to the
24f9e82000-08-05Martin Stjernholm  //! right. If proc_instr is nonzero the set of PI tags is searched, //! else the set of normal element tags.
56ffee2000-01-12Martin Stjernholm  {
24f9e82000-08-05Martin Stjernholm  if (object(Tag) def = get_local_tag (name, proc_instr)) return ({def}) + imported->get_overridden_tags (name, proc_instr) * ({}); else return imported->get_overridden_tags (name, proc_instr) * ({});
2e0a6d2000-07-06Martin Stjernholm  } void add_string_entities (mapping(string:string) entities) //! Adds a set of entitity replacements that are used foremost by
24f9e82000-08-05Martin Stjernholm  //! the PXml parser to decode simple entities like &amp;. The
2e0a6d2000-07-06Martin Stjernholm  //! indices are the entity names without & and ;. { if (string_entities) string_entities |= entities; else string_entities = entities + ([]); changed(); } void clear_string_entities() //! { string_entities = 0; changed(); } mapping(string:string) get_string_entities() //! Returns the set of entity replacements, including those from //! imported tag sets. { if (string_entities) return `+(@imported->get_string_entities(), string_entities); else return `+(@imported->get_string_entities(), ([]));
56ffee2000-01-12Martin Stjernholm  }
24f9e82000-08-05Martin Stjernholm  mapping(string:Tag) get_plugins (string name, void|int proc_instr)
c159ec2000-02-04Martin Stjernholm  //! Returns the registered plugins for the given tag name. Don't be
24f9e82000-08-05Martin Stjernholm  //! destructive on the returned mapping. If proc_instr is nonzero, //! the function searches for processing instruction plugins, //! otherwise it searches for plugins to normal element tags.
c159ec2000-02-04Martin Stjernholm  { mapping(string:Tag) res;
24f9e82000-08-05Martin Stjernholm  if (proc_instr) { if (!pi_plugins) pi_plugins = ([]); if ((res = pi_plugins[name])) return res; low_get_pi_plugins (name + "#", res = ([])); return pi_plugins[name] = res; } else { if (!plugins) plugins = ([]); if ((res = plugins[name])) return res; low_get_plugins (name + "#", res = ([])); return plugins[name] = res; }
c159ec2000-02-04Martin Stjernholm  }
87fb7e2000-03-25Martin Stjernholm  int has_effective_tags (TagSet tset) //! This one deserves some explanation. { return tset == top_tag_set && !got_local_tags; }
ed81751999-12-11Martin Stjernholm  mixed `->= (string var, mixed val) { switch (var) { case "imported":
49897a2000-02-13Martin Stjernholm  if (!val) return val; // Pike can call us with 0 as part of an optimization. filter (imported, "dont_notify", changed);
ed81751999-12-11Martin Stjernholm  imported = [array(TagSet)] val; imported->do_notify (changed);
87fb7e2000-03-25Martin Stjernholm  top_tag_set = sizeof (imported) && imported[0];
ed81751999-12-11Martin Stjernholm  break; default: ::`->= (var, val); } changed(); return val; } mixed `[]= (string var, mixed val) {return `->= (var, val);} Parser `() (Type top_level_type, void|RequestID id) //! Creates a new context for parsing content of the specified type, //! and returns the parser object for it. id is put into the //! context. {
660cb52000-01-12Martin Stjernholm  Context ctx = Context (this_object(), id); if (!prepare_funs) prepare_funs = get_prepare_funs();
777ff22000-02-15Martin Stjernholm  (prepare_funs -= ({0})) (ctx);
660cb52000-01-12Martin Stjernholm  return ctx->new_parser (top_level_type);
ed81751999-12-11Martin Stjernholm  } void changed() //! Should be called whenever something is changed. Done //! automatically most of the time, however. { generation++;
660cb52000-01-12Martin Stjernholm  prepare_funs = 0;
51f88b2000-06-23Martin Stjernholm  overridden_tag_lookup = 0;
24f9e82000-08-05Martin Stjernholm  plugins = pi_plugins = 0;
ed81751999-12-11Martin Stjernholm  (notify_funcs -= ({0}))(); set_weak_flag (notify_funcs, 1);
24f9e82000-08-05Martin Stjernholm  got_local_tags = sizeof (tags) || (proc_instrs && sizeof (proc_instrs));
ed81751999-12-11Martin Stjernholm  } // Internals. void do_notify (function(:void) func) { notify_funcs |= ({func}); set_weak_flag (notify_funcs, 1); } void dont_notify (function(:void) func) { notify_funcs -= ({func}); set_weak_flag (notify_funcs, 1); } void destroy() { catch (changed()); }
24f9e82000-08-05Martin Stjernholm  static mapping(string:Tag) tags = ([]), proc_instrs; // Static since we want to track changes in these.
2e0a6d2000-07-06Martin Stjernholm  static mapping(string:string) string_entities; // Used by e.g. PXml to hold normal entities that should be replaced // during parsing.
ed81751999-12-11Martin Stjernholm 
87fb7e2000-03-25Martin Stjernholm  static TagSet top_tag_set; // The imported tag set with the highest priority. static int got_local_tags;
24f9e82000-08-05Martin Stjernholm  // Nonzero if there are local element tags or PI tags.
87fb7e2000-03-25Martin Stjernholm 
c159ec2000-02-04Martin Stjernholm  static array(function(:void)) notify_funcs = ({});
ed81751999-12-11Martin Stjernholm  // Weak (when nonempty).
2bd21a2000-01-05Martin Stjernholm 
c159ec2000-02-04Martin Stjernholm  static array(function(Context:void)) prepare_funs;
660cb52000-01-12Martin Stjernholm 
c159ec2000-02-04Martin Stjernholm  /*static*/ array(function(Context:void)) get_prepare_funs()
660cb52000-01-12Martin Stjernholm  { if (prepare_funs) return prepare_funs; array(function(Context:void)) funs = ({}); for (int i = sizeof (imported) - 1; i >= 0; i--) funs += imported[i]->get_prepare_funs(); if (prepare_context) funs += ({prepare_context}); // We don't cache in prepare_funs; do that only at the top level. return funs; }
2e0a6d2000-07-06Martin Stjernholm  static mapping(Tag:Tag) overridden_tag_lookup;
51f88b2000-06-23Martin Stjernholm 
2e0a6d2000-07-06Martin Stjernholm  /*static*/ Tag find_overridden_tag (Tag overrider)
51f88b2000-06-23Martin Stjernholm  {
2e0a6d2000-07-06Martin Stjernholm  if (tags[overrider->name] == overrider) {
51f88b2000-06-23Martin Stjernholm  foreach (imported, TagSet tag_set)
2e0a6d2000-07-06Martin Stjernholm  if (object(Tag) overrider = tag_set->get_tag (overrider->name)) return overrider;
51f88b2000-06-23Martin Stjernholm  } else { int found = 0; foreach (imported, TagSet tag_set)
2e0a6d2000-07-06Martin Stjernholm  if (object(Tag) subtag = tag_set->get_tag (overrider->name))
51f88b2000-06-23Martin Stjernholm  if (found) return subtag;
2e0a6d2000-07-06Martin Stjernholm  else if (subtag == overrider) if ((subtag = tag_set->find_overridden_tag (overrider)))
51f88b2000-06-23Martin Stjernholm  return subtag; else found = 1; } return 0; }
24f9e82000-08-05Martin Stjernholm  /*static*/ Tag find_overridden_proc_instr (Tag overrider) { if (proc_instrs && proc_instrs[overrider->name] == overrider) { foreach (imported, TagSet tag_set) if (object(Tag) overrider = tag_set->get_proc_instr (overrider->name)) return overrider; } else { int found = 0; foreach (imported, TagSet tag_set) if (object(Tag) subtag = tag_set->get_proc_instr (overrider->name)) if (found) return subtag; else if (subtag == overrider) if ((subtag = tag_set->find_overridden_proc_instr (overrider))) return subtag; else found = 1; } return 0; }
777ff22000-02-15Martin Stjernholm  void call_prepare_funs (Context ctx) // Kludge function used from rxml.pike. { if (!prepare_funs) prepare_funs = get_prepare_funs(); (prepare_funs -= ({0})) (ctx); }
24f9e82000-08-05Martin Stjernholm  static mapping(string:mapping(string:Tag)) plugins, pi_plugins;
c159ec2000-02-04Martin Stjernholm  /*static*/ void low_get_plugins (string prefix, mapping(string:Tag) res) { for (int i = sizeof (imported) - 1; i >= 0; i--) imported[i]->low_get_plugins (prefix, res); foreach (indices (tags), string name) if (name[..sizeof (prefix) - 1] == prefix) { Tag tag = tags[name]; if (tag->plugin_name) res[[string] tag->plugin_name] = tag; } // We don't cache in plugins; do that only at the top level. }
24f9e82000-08-05Martin Stjernholm  /*static*/ void low_get_pi_plugins (string prefix, mapping(string:Tag) res) { for (int i = sizeof (imported) - 1; i >= 0; i--) imported[i]->low_get_pi_plugins (prefix, res); if (proc_instrs) foreach (indices (proc_instrs), string name) if (name[..sizeof (prefix) - 1] == prefix) { Tag tag = proc_instrs[name]; if (tag->plugin_name) res[[string] tag->plugin_name] = tag; } // We don't cache in pi_plugins; do that only at the top level. }
2bd21a2000-01-05Martin Stjernholm  string _sprintf() {
f02d002000-03-18Martin Stjernholm  return sprintf ("RXML.TagSet(%O,%d)%s", name, id_number, OBJ_COUNT);
2bd21a2000-01-05Martin Stjernholm  }
ec027c2000-03-16Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  MARK_OBJECT_ONLY;
ed81751999-12-11Martin Stjernholm }
1b2b752000-01-07Martin Stjernholm TagSet empty_tag_set;
ed81751999-12-11Martin Stjernholm //! The empty tag set.
af06d52000-01-12Martin Stjernholm class Value //! Interface for objects used as variable values that are evaluated //! when referenced. {
a21fcb2000-02-08Martin Nilsson  mixed rxml_var_eval (Context ctx, string var, string scope_name, void|Type type)
8778dd2000-02-05Martin Stjernholm  //! This is called to get the value of the variable. ctx, var and
710b482000-02-07Martin Stjernholm  //! scope_name are set to where this Value object was found. //! //! If the type argument is given, it's the type the returned value //! should have. If the value can't be converted to that type, an //! RXML error should be thrown. If you don't want to do any special
23a0882000-08-12Martin Stjernholm  //! handling of this, it's enough to call type->encode(value), //! since the encode functions does just that.
a21fcb2000-02-08Martin Nilsson  { mixed val = rxml_const_eval (ctx, var, scope_name, type); ctx->set_var(var, val, scope_name); return val; }
9d80e82000-02-11Martin Stjernholm  mixed rxml_const_eval (Context ctx, string var, string scope_name, void|Type type);
a21fcb2000-02-08Martin Nilsson  //! If the variable value is the same throughout the life of the context, //! this method could be used instead of rxml_var_eval.
26ff092000-01-21Martin Stjernholm  string _sprintf() {return "RXML.Value";}
af06d52000-01-12Martin Stjernholm } class Scope //! Interface for objects that emulates a scope mapping. {
01e43b2000-01-14Martin Stjernholm  mixed `[] (string var, void|Context ctx, void|string scope_name)
5ed0132000-02-13Martin Stjernholm  {parse_error ("Cannot query variable" + _in_the_scope (scope_name) + ".\n");}
01e43b2000-01-14Martin Stjernholm  mixed `[]= (string var, mixed val, void|Context ctx, void|string scope_name)
5ed0132000-02-13Martin Stjernholm  {parse_error ("Cannot set variable" + _in_the_scope (scope_name) + ".\n");}
01e43b2000-01-14Martin Stjernholm  array(string) _indices (void|Context ctx, void|string scope_name)
5ed0132000-02-13Martin Stjernholm  {parse_error ("Cannot list variables" + _in_the_scope (scope_name) + ".\n");}
01e43b2000-01-14Martin Stjernholm  void m_delete (string var, void|Context ctx, void|string scope_name)
5ed0132000-02-13Martin Stjernholm  {parse_error ("Cannot delete variable" + _in_the_scope (scope_name) + ".\n");}
01e43b2000-01-14Martin Stjernholm  private string _in_the_scope (string scope_name) { if (scope_name)
3e59342000-01-18Martin Stjernholm  if (scope_name != "_") return " in the scope " + scope_name;
01e43b2000-01-14Martin Stjernholm  else return " in the current scope"; else return ""; }
26ff092000-01-21Martin Stjernholm  string _sprintf() {return "RXML.Scope";}
af06d52000-01-12Martin Stjernholm }
01e43b2000-01-14Martin Stjernholm #define SCOPE_TYPE mapping(string:mixed)|object(Scope)
ed81751999-12-11Martin Stjernholm class Context //! A parser context. This contains the current variable bindings and //! so on. The current context can always be retrieved with //! get_context(). //!
db04172000-01-14Martin Stjernholm //! Note: Don't store pointers to this object since that will likely
ed81751999-12-11Martin Stjernholm //! introduce circular references. It can be retrieved easily through //! get_context() or parser->context. { Frame frame; //! The currently evaluating frame.
ffa6932000-02-20Martin Stjernholm  int frame_depth; //! Number of frames currently on the frame stack. int max_frame_depth = 100; //! Maximum number of frames allowed on the frame stack.
ed81751999-12-11Martin Stjernholm  RequestID id; //! int type_check; //! Whether to do type checking.
db04172000-01-14Martin Stjernholm  int error_count; //! Number of RXML errors that has occurred.
01e43b2000-01-14Martin Stjernholm 
1b2b752000-01-07Martin Stjernholm  TagSet tag_set;
ed81751999-12-11Martin Stjernholm  //! The current tag set that will be inherited by subparsers.
c8021c2000-02-15Martin Nilsson #ifdef OLD_RXML_COMPAT int compatible_scope = 0; //! If set, the default scope is form, otherwise it is the present //! scope. #endif
9390fe2000-01-23Martin Nilsson  array parse_user_var (string var, void|string scope_name)
291ade2000-01-25Martin Stjernholm  //! Tries to decide what variable and scope to use. Handles cases //! where the variable also contains the scope, e.g. "scope.var".
9390fe2000-01-23Martin Nilsson  { if(!var || !sizeof(var)) return ([])[0];
0d37f22000-04-15Martin Nilsson  if(scope_name) return ({ scope_name, var }); array(string) splitted = Array.map( replace(var, "..", ";") / ".", lambda(string in) { return replace(in, ";", "."); });
c8021c2000-02-15Martin Nilsson  if(sizeof(splitted)>2) splitted[-1] = splitted[1..]*".";
b185482000-01-25Martin Nilsson  if(sizeof(splitted)==2) scope_name=splitted[0];
c8021c2000-02-15Martin Nilsson #ifdef OLD_RXML_COMPAT else if (compatible_scope) scope_name = scope_name || "form"; #endif
9390fe2000-01-23Martin Nilsson  return ({ scope_name, splitted[-1] }); }
8778dd2000-02-05Martin Stjernholm  local mixed get_var (string var, void|string scope_name, void|Type want_type)
ed81751999-12-11Martin Stjernholm  //! Returns the value a variable in the specified scope, or the //! current scope if none is given. Returns zero with zero_type 1 if //! there's no such variable.
8778dd2000-02-05Martin Stjernholm  //!
710b482000-02-07Martin Stjernholm  //! If the type argument is set, the value is converted to that type
23a0882000-08-12Martin Stjernholm  //! with Type.encode(). If the value can't be converted, an RXML
710b482000-02-07Martin Stjernholm  //! error is thrown.
ed81751999-12-11Martin Stjernholm  {
3e59342000-01-18Martin Stjernholm  if (SCOPE_TYPE vars = scopes[scope_name || "_"]) {
ed81751999-12-11Martin Stjernholm  mixed val;
5708532000-01-15Martin Stjernholm  if (objectp (vars)) {
2591bd2000-02-07Martin Stjernholm  if (zero_type (val = ([object(Scope)] vars)->`[] ( var, this_object(), scope_name || "_")) ||
46c68f2000-08-12Martin Stjernholm  val == nil)
2591bd2000-02-07Martin Stjernholm  return ([])[0];
01e43b2000-01-14Martin Stjernholm  }
2591bd2000-02-07Martin Stjernholm  else if (zero_type (val = vars[var])) return ([])[0];
a21fcb2000-02-08Martin Nilsson  if (objectp (val) && ([object] val)->rxml_var_eval) {
8778dd2000-02-05Martin Stjernholm  return zero_type (val = ([object(Value)] val)->rxml_var_eval ( this_object(), var, scope_name || "_", want_type)) ||
46c68f2000-08-12Martin Stjernholm  val == nil ? ([])[0] : val;
a21fcb2000-02-08Martin Nilsson  }
710b482000-02-07Martin Stjernholm  else if (want_type) return // FIXME: Some system to find out the source type?
23a0882000-08-12Martin Stjernholm  zero_type (val = want_type->encode (val)) ||
46c68f2000-08-12Martin Stjernholm  val == nil ? ([])[0] : val;
710b482000-02-07Martin Stjernholm  else return val;
ed81751999-12-11Martin Stjernholm  }
9290ad2000-02-20Martin Stjernholm  else if ((<0, "_">)[scope_name]) parse_error ("No current scope.\n"); else parse_error ("Unknown scope %O.\n", scope_name);
ed81751999-12-11Martin Stjernholm  }
8778dd2000-02-05Martin Stjernholm  mixed user_get_var (string var, void|string scope_name, void|Type want_type)
291ade2000-01-25Martin Stjernholm  //! As get_var, but can handle cases where the variable also //! contains the scope, e.g. "scope.var".
9390fe2000-01-23Martin Nilsson  { if(!var || !sizeof(var)) return ([])[0];
0d37f22000-04-15Martin Nilsson  if(scope_name) return get_var(var, scope_name, want_type); array(string) splitted = Array.map( replace(var, "..", ";") / ".", lambda(string in) { return replace(in, ";", "."); });
c8021c2000-02-15Martin Nilsson  if(sizeof(splitted)>2) splitted[-1] = splitted[1..]*".";
b185482000-01-25Martin Nilsson  if(sizeof(splitted)==2) scope_name=splitted[0];
c8021c2000-02-15Martin Nilsson #ifdef OLD_RXML_COMPAT else if (compatible_scope) scope_name = scope_name || "form"; #endif
8778dd2000-02-05Martin Stjernholm  return get_var(splitted[-1], scope_name, want_type);
9390fe2000-01-23Martin Nilsson  }
291ade2000-01-25Martin Stjernholm  local mixed set_var (string var, mixed val, void|string scope_name)
ed81751999-12-11Martin Stjernholm  //! Sets the value of a variable in the specified scope, or the //! current scope if none is given. Returns val. {
3e59342000-01-18Martin Stjernholm  if (SCOPE_TYPE vars = scopes[scope_name || "_"])
01e43b2000-01-14Martin Stjernholm  if (objectp (vars))
3e59342000-01-18Martin Stjernholm  return ([object(Scope)] vars)->`[]= (var, val, this_object(), scope_name || "_");
01e43b2000-01-14Martin Stjernholm  else return vars[var] = val;
9290ad2000-02-20Martin Stjernholm  else if ((<0, "_">)[scope_name]) parse_error ("No current scope.\n"); else parse_error ("Unknown scope %O.\n", scope_name);
ed81751999-12-11Martin Stjernholm  }
9390fe2000-01-23Martin Nilsson  mixed user_set_var (string var, mixed val, void|string scope_name)
291ade2000-01-25Martin Stjernholm  //! As set_var, but can handle cases where the variable also //! contains the scope, e.g. "scope.var".
9390fe2000-01-23Martin Nilsson  {
c8021c2000-02-15Martin Nilsson  if(!var || !sizeof(var)) parse_error ("No variable specified.\n");
0d37f22000-04-15Martin Nilsson  if(scope_name) return set_var(var, val, scope_name); array(string) splitted = Array.map( replace(var, "..", ";") / ".", lambda(string in) { return replace(in, ";", "."); });
c8021c2000-02-15Martin Nilsson  if(sizeof(splitted)>2) splitted[-1] = splitted[1..]*".";
b185482000-01-25Martin Nilsson  if(sizeof(splitted)==2) scope_name=splitted[0];
c8021c2000-02-15Martin Nilsson #ifdef OLD_RXML_COMPAT else if (compatible_scope) scope_name = scope_name || "form"; #endif
9390fe2000-01-23Martin Nilsson  return set_var(splitted[-1], val, scope_name); }
291ade2000-01-25Martin Stjernholm  local void delete_var (string var, void|string scope_name)
ed81751999-12-11Martin Stjernholm  //! Removes a variable in the specified scope, or the current scope //! if none is given. {
3e59342000-01-18Martin Stjernholm  if (SCOPE_TYPE vars = scopes[scope_name || "_"])
01e43b2000-01-14Martin Stjernholm  if (objectp (vars))
3e59342000-01-18Martin Stjernholm  ([object(Scope)] vars)->m_delete (var, this_object(), scope_name || "_");
01e43b2000-01-14Martin Stjernholm  else m_delete ([mapping(string:mixed)] vars, var);
9290ad2000-02-20Martin Stjernholm  else if ((<0, "_">)[scope_name]) parse_error ("No current scope.\n"); else parse_error ("Unknown scope %O.\n", scope_name);
ed81751999-12-11Martin Stjernholm  }
291ade2000-01-25Martin Stjernholm  void user_delete_var (string var, void|string scope_name) //! As delete_var, but can handle cases where the variable also //! contains the scope, e.g. "scope.var".
9390fe2000-01-23Martin Nilsson  {
291ade2000-01-25Martin Stjernholm  if(!var || !sizeof(var)) return;
0d37f22000-04-15Martin Nilsson  if(scope_name) { delete_var(var, scope_name); return; } array(string) splitted = Array.map( replace(var, "..", ";") / ".", lambda(string in) { return replace(in, ";", "."); });
c8021c2000-02-15Martin Nilsson  if(sizeof(splitted)>2) splitted[-1] = splitted[1..]*".";
b185482000-01-25Martin Nilsson  if(sizeof(splitted)==2) scope_name=splitted[0];
c8021c2000-02-15Martin Nilsson #ifdef OLD_RXML_COMPAT else if (compatible_scope) scope_name = scope_name || "form"; #endif
291ade2000-01-25Martin Stjernholm  delete_var(splitted[-1], scope_name);
9390fe2000-01-23Martin Nilsson  }
ed81751999-12-11Martin Stjernholm  array(string) list_var (void|string scope_name) //! Returns the names of all variables in the specified scope, or //! the current scope if none is given. {
3e59342000-01-18Martin Stjernholm  if (SCOPE_TYPE vars = scopes[scope_name || "_"])
01e43b2000-01-14Martin Stjernholm  if (objectp (vars))
3e59342000-01-18Martin Stjernholm  return ([object(Scope)] vars)->_indices (this_object(), scope_name || "_");
01e43b2000-01-14Martin Stjernholm  else return indices ([mapping(string:mixed)] vars);
9290ad2000-02-20Martin Stjernholm  else if ((<0, "_">)[scope_name]) parse_error ("No current scope.\n"); else parse_error ("Unknown scope %O.\n", scope_name);
ed81751999-12-11Martin Stjernholm  } array(string) list_scopes() //! Returns the names of all defined scopes. {
3e59342000-01-18Martin Stjernholm  return indices (scopes) - ({"_"});
ed81751999-12-11Martin Stjernholm  }
af06d52000-01-12Martin Stjernholm  int exist_scope (void|string scope_name) //! {
3e59342000-01-18Martin Stjernholm  return !!scopes[scope_name || "_"];
af06d52000-01-12Martin Stjernholm  } void add_scope (string scope_name, SCOPE_TYPE vars) //! Adds or replaces the specified scope at the global level. A
291ade2000-01-25Martin Stjernholm  //! scope can be a mapping or a Scope object. A global "_" scope may //! also be defined this way.
ed81751999-12-11Martin Stjernholm  { if (scopes[scope_name])
3e59342000-01-18Martin Stjernholm  if (scope_name == "_") {
291ade2000-01-25Martin Stjernholm  array(SCOPE_TYPE) hid; for (Frame f = frame; f; f = f->up) if (array(SCOPE_TYPE) h = hidden[f]) hid = h; if (hid) hid[0] = vars; else scopes["_"] = vars;
ed81751999-12-11Martin Stjernholm  } else { Frame outermost; for (Frame f = frame; f; f = f->up) if (f->scope_name == scope_name) outermost = f;
291ade2000-01-25Martin Stjernholm  if (outermost) hidden[outermost][1] = vars;
ed81751999-12-11Martin Stjernholm  else scopes[scope_name] = vars; } else scopes[scope_name] = vars; }
290c802000-01-25Martin Nilsson  int extend_scope (string scope_name, SCOPE_TYPE vars)
291ade2000-01-25Martin Stjernholm  //! Adds or extends the specified scope at the global level.
290c802000-01-25Martin Nilsson  //! Returns 1 on success and 0 on failure.
0273b22000-01-21Martin Nilsson  {
291ade2000-01-25Martin Stjernholm  if (scopes[scope_name]) { SCOPE_TYPE oldvars; if (scope_name == "_") { array(SCOPE_TYPE) hid; for (Frame f = frame; f; f = f->up) if (array(SCOPE_TYPE) h = hidden[f]) hid = h; if (hid) oldvars = hid[0]; else oldvars = scopes["_"]; } else { Frame outermost; for (Frame f = frame; f; f = f->up) if (f->scope_name == scope_name) outermost = f; if (outermost) oldvars = hidden[outermost][1]; else oldvars = scopes[scope_name]; } #ifdef DEBUG
8cb24d2000-02-13Martin Stjernholm  if (!oldvars) fatal_error ("Internal error: I before e except after c.\n");
291ade2000-01-25Martin Stjernholm #endif if (!mappingp(vars)) { return 0; } foreach (indices(vars), string var) set_var(var, vars[var], scope_name);
f6020c2000-01-23Martin Nilsson  }
291ade2000-01-25Martin Stjernholm  else scopes[scope_name] = vars;
290c802000-01-25Martin Nilsson  return 1;
0273b22000-01-21Martin Nilsson  }
ed81751999-12-11Martin Stjernholm  void remove_scope (string scope_name) //! Removes the named scope from the global level, if it exists. { #ifdef MODULE_DEBUG
8cb24d2000-02-13Martin Stjernholm  if (scope_name == "_") fatal_error ("Cannot remove current scope.\n");
ed81751999-12-11Martin Stjernholm #endif Frame outermost; for (Frame f = frame; f; f = f->up) if (f->scope_name == scope_name) outermost = f; if (outermost) m_delete (hidden, outermost); else m_delete (scopes, scope_name); } string current_scope() //! Returns the name of the current scope, if it has any. {
3e59342000-01-18Martin Stjernholm  if (SCOPE_TYPE vars = scopes["_"]) {
ed81751999-12-11Martin Stjernholm  string scope_name; while (scope_name = search (scopes, vars, scope_name))
3e59342000-01-18Martin Stjernholm  if (scope_name != "_") return scope_name;
ed81751999-12-11Martin Stjernholm  } return 0; }
af06d52000-01-12Martin Stjernholm  void add_runtime_tag (Tag tag) //! Adds a tag that will exist from this point forward in the
0ebc9d2000-02-15Martin Stjernholm  //! current context only.
af06d52000-01-12Martin Stjernholm  {
24f9e82000-08-05Martin Stjernholm #ifdef MODULE_DEBUG if (tag->plugin_name) fatal_error ("Can't currently handle adding of plugin tags at runtime.\n"); #endif
0ebc9d2000-02-15Martin Stjernholm  if (!new_runtime_tags) new_runtime_tags = NewRuntimeTags();
24f9e82000-08-05Martin Stjernholm  new_runtime_tags->add_tag (tag);
af06d52000-01-12Martin Stjernholm  }
24f9e82000-08-05Martin Stjernholm  void remove_runtime_tag (string|Tag tag, void|int proc_instr) //! If tag is a Tag object, it's removed from the set of runtime //! tags. If tag is a string, the tag with that name is removed. In //! the latter case, if proc_instr is nonzero the set of runtime PI //! tags is searched, else the set of normal element runtime tags.
af06d52000-01-12Martin Stjernholm  {
0ebc9d2000-02-15Martin Stjernholm  if (!new_runtime_tags) new_runtime_tags = NewRuntimeTags();
87fb7e2000-03-25Martin Stjernholm  if (objectp (tag)) tag = tag->name;
24f9e82000-08-05Martin Stjernholm  new_runtime_tags->remove_tag (tag);
af06d52000-01-12Martin Stjernholm  }
18abb32000-02-15Martin Stjernholm  multiset(Tag) get_runtime_tags()
24f9e82000-08-05Martin Stjernholm  //! Returns all currently active runtime tags.
0ebc9d2000-02-15Martin Stjernholm  {
87fb7e2000-03-25Martin Stjernholm  mapping(string:Tag) tags = runtime_tags;
24f9e82000-08-05Martin Stjernholm  if (new_runtime_tags) tags = new_runtime_tags->filter_tags (tags);
87fb7e2000-03-25Martin Stjernholm  return mkmultiset (values (tags));
0ebc9d2000-02-15Martin Stjernholm  }
01e43b2000-01-14Martin Stjernholm  void handle_exception (mixed err, PCode|Parser evaluator) //! This function gets any exception that is catched during //! evaluation. evaluator is the object that catched the error.
c757c42000-01-08Martin Stjernholm  {
db04172000-01-14Martin Stjernholm  error_count++;
c64acf2000-02-17Martin Stjernholm  if (objectp (err) && err->is_RXML_Backtrace) {
8cb24d2000-02-13Martin Stjernholm  string msg; for (object(PCode)|object(Parser) e = evaluator->_parent; e; e = e->_parent) e->error_count++;
01e43b2000-01-14Martin Stjernholm  if (id && id->conf)
9290ad2000-02-20Martin Stjernholm  while (evaluator) { if (evaluator->report_error && evaluator->type->free_text) {
b483382000-06-30Martin Stjernholm  string msg = err->type == "help" ? err->msg : (err->type == "run" ? ([function(Backtrace,Type:string)] ([object] id->conf)->handle_run_error) : ([function(Backtrace,Type:string)] ([object] id->conf)->handle_parse_error) ) ([object(Backtrace)] err, evaluator->type);
9290ad2000-02-20Martin Stjernholm  if (evaluator->report_error (msg)) break; } evaluator = evaluator->_parent; }
01e43b2000-01-14Martin Stjernholm  else {
c757c42000-01-08Martin Stjernholm #ifdef MODULE_DEBUG
01e43b2000-01-14Martin Stjernholm  report_notice (describe_backtrace (err));
c757c42000-01-08Martin Stjernholm #else
8cb24d2000-02-13Martin Stjernholm  report_notice (err->msg);
c757c42000-01-08Martin Stjernholm #endif
01e43b2000-01-14Martin Stjernholm  }
c757c42000-01-08Martin Stjernholm  }
8cb24d2000-02-13Martin Stjernholm  else throw_fatal (err);
c757c42000-01-08Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm  // Internals.
db04172000-01-14Martin Stjernholm  string current_var; // Used to get the parsed variable into the RXML error backtrace.
c6245b1999-12-31Martin Stjernholm  Parser new_parser (Type top_level_type) // Returns a new parser object to start parsing with this context. // Normally TagSet.`() should be used instead of this. { #ifdef MODULE_DEBUG
8cb24d2000-02-13Martin Stjernholm  if (in_use || frame) fatal_error ("Context already in use.\n");
c6245b1999-12-31Martin Stjernholm #endif return top_level_type->get_parser (this_object()); }
af06d52000-01-12Martin Stjernholm  mapping(string:SCOPE_TYPE) scopes = ([]);
ed81751999-12-11Martin Stjernholm  // The variable mappings for every currently visible scope. A
3e59342000-01-18Martin Stjernholm  // special entry "_" points to the current local scope.
ed81751999-12-11Martin Stjernholm 
291ade2000-01-25Martin Stjernholm  mapping(Frame:array(SCOPE_TYPE)) hidden = ([]); // The currently hidden scopes. The indices are frame objects which // introduce scopes. The values are tuples of the current scope and // the named scope they hide.
ed81751999-12-11Martin Stjernholm  void enter_scope (Frame frame) { #ifdef DEBUG
8cb24d2000-02-13Martin Stjernholm  if (!frame->vars) fatal_error ("Internal error: Frame has no variables.\n");
ed81751999-12-11Martin Stjernholm #endif
b2d01b2000-02-15Martin Stjernholm  if (string scope_name = [string] frame->scope_name) { if (!hidden[frame])
291ade2000-01-25Martin Stjernholm  hidden[frame] = ({scopes["_"], scopes[scope_name]});
b2d01b2000-02-15Martin Stjernholm  scopes["_"] = scopes[scope_name] = [SCOPE_TYPE] frame->vars; } else { if (!hidden[frame])
291ade2000-01-25Martin Stjernholm  hidden[frame] = ({scopes["_"], 0});
b2d01b2000-02-15Martin Stjernholm  scopes["_"] = [SCOPE_TYPE] frame->vars; }
ed81751999-12-11Martin Stjernholm  } void leave_scope (Frame frame) {
291ade2000-01-25Martin Stjernholm  if (array(SCOPE_TYPE) back = hidden[frame]) { if (SCOPE_TYPE cur = back[0]) scopes["_"] = cur; else m_delete (scopes, "_"); if (SCOPE_TYPE named = back[1]) { #ifdef MODULE_DEBUG if (!stringp (frame->scope_name))
8cb24d2000-02-13Martin Stjernholm  fatal_error ("Scope named changed to %O during parsing.\n", frame->scope_name);
291ade2000-01-25Martin Stjernholm #endif scopes[[string] frame->scope_name] = named;
ed81751999-12-11Martin Stjernholm  }
291ade2000-01-25Martin Stjernholm  else m_delete (scopes, [string] frame->scope_name); m_delete (hidden, frame);
ed81751999-12-11Martin Stjernholm  } } #define ENTER_SCOPE(ctx, frame) (frame->vars && ctx->enter_scope (frame)) #define LEAVE_SCOPE(ctx, frame) (frame->vars && ctx->leave_scope (frame))
87fb7e2000-03-25Martin Stjernholm  mapping(string:Tag) runtime_tags = ([]);
24f9e82000-08-05Martin Stjernholm  // The active runtime tags. PI tags are stored in the same mapping // with their names prefixed by '?'.
0ebc9d2000-02-15Martin Stjernholm  NewRuntimeTags new_runtime_tags;
c6245b1999-12-31Martin Stjernholm  // Used to record the result of any add_runtime_tag() and // remove_runtime_tag() calls since the last time the parsers ran.
ed81751999-12-11Martin Stjernholm 
26ff092000-01-21Martin Stjernholm  void create (TagSet _tag_set, void|RequestID _id)
ed81751999-12-11Martin Stjernholm  // Normally TagSet.`() should be used instead of this. {
1b2b752000-01-07Martin Stjernholm  tag_set = _tag_set;
ed81751999-12-11Martin Stjernholm  id = _id;
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG __object_marker->create (this_object()); #endif
ed81751999-12-11Martin Stjernholm  }
56532d1999-12-19Martin Stjernholm  mapping(string:mixed)|mapping(object:array) unwind_state;
ed81751999-12-11Martin Stjernholm  // If this is a mapping, we have an unwound stack state. It contains
56532d1999-12-19Martin Stjernholm  // strings with arbitrary exception info, and the objects being // unwound with arrays containing the extra state info they need. // The first entry in these arrays are always the subobject. The // special entries are:
ed81751999-12-11Martin Stjernholm  //
56532d1999-12-19Martin Stjernholm  // "top": ({Frame|Parser|PCode (top object)})
ed81751999-12-11Martin Stjernholm  // "stream_piece": mixed (When continuing, do a streaming
91c8982000-03-11Martin Stjernholm  // do_process() with this stream piece.)
ed81751999-12-11Martin Stjernholm  // "exec_left": array (Exec array left to evaluate. Only used // between Frame._exec_array() and Frame._eval().)
f02d002000-03-18Martin Stjernholm  MARK_OBJECT_ONLY;
2bd21a2000-01-05Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.Context" + OBJ_COUNT;}
ec027c2000-03-16Martin Stjernholm 
ed81751999-12-11Martin Stjernholm #ifdef MODULE_DEBUG
2d20342000-02-12Martin Stjernholm #if constant (thread_create) Thread.Thread in_use; #else
ed81751999-12-11Martin Stjernholm  int in_use; #endif
2d20342000-02-12Martin Stjernholm #endif
ed81751999-12-11Martin Stjernholm }
ec027c2000-03-16Martin Stjernholm static class NewRuntimeTags
24f9e82000-08-05Martin Stjernholm // Tool class used to track runtime tags in Context.
ec027c2000-03-16Martin Stjernholm {
24f9e82000-08-05Martin Stjernholm  static mapping(string:Tag) add_tags; static mapping(string:int|string) remove_tags; void add_tag (Tag tag) { if (!add_tags) add_tags = ([]); if (tag->flags & FLAG_PROC_INSTR) { add_tags["?" + tag->name] = tag; // By doing the following, we can let remove_proc_instrs take precedence. if (remove_tags) m_delete (remove_tags, "?" + tag->name); } else { add_tags[tag->name] = tag; if (remove_tags) m_delete (remove_tags, tag->name); } } void remove_tag (string name, int proc_instr) { if (!remove_tags) remove_tags = ([]); if (proc_instr) remove_tags["?" + name] = name; else remove_tags[name] = 1; } array(Tag) added_tags() { if (!add_tags) return ({}); if (remove_tags) return values (add_tags - remove_tags); return values (add_tags); } array(string) removed_tags() { return remove_tags ? indices (filter (remove_tags, intp)) : ({}); } array(string) removed_pi_tags() { return remove_tags ? values (remove_tags) - ({1}) : ({}); } mapping(string:Tag) filter_tags (mapping(string:Tag) tags) { if (add_tags) tags |= add_tags; if (remove_tags) tags -= remove_tags; return tags; }
ec027c2000-03-16Martin Stjernholm }
8cb24d2000-02-13Martin Stjernholm class Backtrace //! The object used to throw RXML errors. { constant is_generic_error = 1; constant is_RXML_Backtrace = 1;
0ebc9d2000-02-15Martin Stjernholm  string type; // Currently "run" or "parse".
8cb24d2000-02-13Martin Stjernholm  string msg; Context context; Frame frame; string current_var; array backtrace;
51f88b2000-06-23Martin Stjernholm  void create (void|string _type, void|string _msg, void|Context _context, void|array _backtrace)
8cb24d2000-02-13Martin Stjernholm  { type = _type; msg = _msg; if (context = _context || get_context()) { frame = context->frame; current_var = context->current_var; }
51f88b2000-06-23Martin Stjernholm  if (_backtrace) backtrace = _backtrace; else { backtrace = predef::backtrace(); backtrace = backtrace[..sizeof (backtrace) - 2]; }
8cb24d2000-02-13Martin Stjernholm  } string describe_rxml_backtrace (void|int no_msg) //! Returns a formatted RXML frame backtrace. {
1c73f62000-03-04Martin Stjernholm  string txt = no_msg ? "" : "RXML" + (type ? " " + type : "") + " error";
8cb24d2000-02-13Martin Stjernholm  if (context) { if (!no_msg) txt += ": " + (msg || "(no error message)\n"); txt += current_var ? " | &" + current_var + ";\n" : ""; for (Frame f = frame; f; f = f->up) {
24f9e82000-08-05Martin Stjernholm  string name; if (f->tag) name = f->tag->name;
8cb24d2000-02-13Martin Stjernholm  else if (!f->up) break;
24f9e82000-08-05Martin Stjernholm  else name = "(unknown)"; if (f->flags & FLAG_PROC_INSTR) txt += " | <?" + name + "?>\n"; else { txt += " | <" + name; if (f->args) foreach (sort (indices (f->args)), string arg) { mixed val = f->args[arg]; txt += " " + arg + "="; if (arrayp (val)) txt += map (val, error_print_val) * ","; else txt += error_print_val (val); } else txt += " (no argmap)"; txt += ">\n"; }
8cb24d2000-02-13Martin Stjernholm  } } else if (!no_msg) txt += " (no context): " + (msg || "(no error message)\n"); return txt; } private string error_print_val (mixed val) { if (arrayp (val)) return "array"; else if (mappingp (val)) return "mapping"; else if (multisetp (val)) return "multiset"; else return sprintf ("%O", val); } string|array `[] (int i) { switch (i) { case 0: return describe_rxml_backtrace(); case 1: return backtrace; } }
1c73f62000-03-04Martin Stjernholm  string _sprintf() {return "RXML.Backtrace(" + (type || "") + ")";}
8cb24d2000-02-13Martin Stjernholm }
ed81751999-12-11Martin Stjernholm  //! Current context. //! It's set before any function in RXML.Tag or RXML.Frame is called. #if constant (thread_create)
56532d1999-12-19Martin Stjernholm private Thread.Local _context = thread_local();
5ad5292000-03-09Martin Stjernholm local void set_context (Context ctx) {_context->set (ctx);} local Context get_context() {return [object(Context)] _context->get();}
ed81751999-12-11Martin Stjernholm #else private Context _context;
5ad5292000-03-09Martin Stjernholm local void set_context (Context ctx) {_context = ctx;} local Context get_context() {return _context;}
ed81751999-12-11Martin Stjernholm #endif
2d20342000-02-12Martin Stjernholm #if defined (MODULE_DEBUG) && constant (thread_create)
ed81751999-12-11Martin Stjernholm  // Got races in this debug check, but looks like we have to live with that. :\ #define ENTER_CONTEXT(ctx) \ Context __old_ctx = get_context(); \ set_context (ctx); \ if (ctx) { \
2d20342000-02-12Martin Stjernholm  if (ctx->in_use && ctx->in_use != this_thread()) \
8cb24d2000-02-13Martin Stjernholm  fatal_error ("Attempt to use context asynchronously.\n"); \
2d20342000-02-12Martin Stjernholm  ctx->in_use = this_thread(); \
ed81751999-12-11Martin Stjernholm  } #define LEAVE_CONTEXT() \ if (Context ctx = get_context()) \ if (__old_ctx != ctx) ctx->in_use = 0; \ set_context (__old_ctx); #else #define ENTER_CONTEXT(ctx) \ Context __old_ctx = get_context(); \ set_context (ctx); #define LEAVE_CONTEXT() \ set_context (__old_ctx); #endif
76cbfb2000-02-04Martin Stjernholm 
ed81751999-12-11Martin Stjernholm //! Constants for the bit field RXML.Frame.flags.
8cb24d2000-02-13Martin Stjernholm constant FLAG_NONE = 0x00000000;
c159ec2000-02-04Martin Stjernholm //! The no-flags flag. In case you think 0 is too ugly. ;)
ed81751999-12-11Martin Stjernholm //! Static flags (i.e. tested in the Tag object).
24f9e82000-08-05Martin Stjernholm constant FLAG_PROC_INSTR = 0x00000010; //! Flags this as a processing instruction tag (i.e. one parsed with //! the <?name ... ?> syntax in XML). The string after the tag name to //! the ending separator constitutes the content of the tag. Arguments //! are not used.
c0f5082000-02-21Martin Stjernholm constant FLAG_EMPTY_ELEMENT = 0x00000001;
51f88b2000-06-23Martin Stjernholm //! If set, the tag does not use any content. E.g. with an HTML parser
8cb24d2000-02-13Martin Stjernholm //! this defines whether the tag is a container or not, and in XML //! parsing it simply causes the content (if any) to be thrown away.
ed81751999-12-11Martin Stjernholm 
51f88b2000-06-23Martin Stjernholm constant FLAG_COMPAT_PARSE = 0x00000002; //! Makes the PXml parser parse the tag in an HTML compatible way: If //! FLAG_EMPTY_ELEMENT is set and the tag doesn't end with '/>', it //! will be parsed as an empty element. The effect of this flag in //! other parsers is currently undefined. constant FLAG_NO_PREFIX = 0x00000004;
cece9e2000-01-11Martin Stjernholm //! Never apply any prefix to this tag.
51f88b2000-06-23Martin Stjernholm constant FLAG_SOCKET_TAG = 0x00000008;
c159ec2000-02-04Martin Stjernholm //! Declare the tag to be a socket tag, which accepts plugin tags (see //! Tag.plugin_name for details).
8cb24d2000-02-13Martin Stjernholm constant FLAG_DONT_PREPARSE = 0x00000040;
24f9e82000-08-05Martin Stjernholm //! Don't preparse the content with the PXml parser. This is always //! the case for PI tags, so this flag doesn't have any effect for //! those. This is only used in the simple tag wrapper. Defined here //! as placeholder.
c159ec2000-02-04Martin Stjernholm 
8cb24d2000-02-13Martin Stjernholm constant FLAG_POSTPARSE = 0x00000080; //! Postparse the result with the PXml parser. This is only used in
c159ec2000-02-04Martin Stjernholm //! the simple tag wrapper. Defined here as placeholder.
ed81751999-12-11Martin Stjernholm //! The rest of the flags are dynamic (i.e. tested in the Frame object).
8cb24d2000-02-13Martin Stjernholm constant FLAG_PARENT_SCOPE = 0x00000100;
91c8982000-03-11Martin Stjernholm //! If set, exec arrays will be interpreted in the scope of the parent //! tag, rather than in the current one.
ed81751999-12-11Martin Stjernholm 
8cb24d2000-02-13Martin Stjernholm constant FLAG_NO_IMPLICIT_ARGS = 0x00000200;
ed81751999-12-11Martin Stjernholm //! If set, the parser won't apply any implicit arguments. FIXME: Not //! yet implemented.
8cb24d2000-02-13Martin Stjernholm constant FLAG_STREAM_RESULT = 0x00000400;
91c8982000-03-11Martin Stjernholm //! If set, the do_process() function will be called repeatedly until
ed81751999-12-11Martin Stjernholm //! it returns 0 or no more content is wanted.
8cb24d2000-02-13Martin Stjernholm constant FLAG_STREAM_CONTENT = 0x00000800;
ed81751999-12-11Martin Stjernholm //! If set, the tag supports getting its content in streaming mode:
91c8982000-03-11Martin Stjernholm //! do_process() will be called repeatedly with successive parts of the //! content then. Can't be changed from do_process().
ed81751999-12-11Martin Stjernholm  //! Note: It might be obvious, but using streaming is significantly //! less effective than nonstreaming, so it should only be done when //! big delays are expected.
8cb24d2000-02-13Martin Stjernholm constant FLAG_STREAM = FLAG_STREAM_RESULT | FLAG_STREAM_CONTENT;
ed81751999-12-11Martin Stjernholm 
8cb24d2000-02-13Martin Stjernholm constant FLAG_UNPARSED = 0x00001000;
49897a2000-02-13Martin Stjernholm //! If set, args and content in the frame contain unparsed strings. //! The frame will be parsed before it's evaluated. This flag should //! never be set in Tag.flags, but it's useful when creating frames //! directly.
9a38062000-08-04Martin Stjernholm constant FLAG_RAW_ARGS = 0x00002000; //! Special flag to TXml.format_tag(); only defined here as a //! placeholder. When this is given to TXml.format_tag(), it only //! encodes the argument quote character with the "Roxen encoding" //! when writing argument values, instead of encoding with entity //! references. It's intended for reformatting a tag which has been //! parsed by Parser.HTML() (or parse_html()) but hasn't been //! processed further.
ed81751999-12-11Martin Stjernholm //! The following flags specifies whether certain conditions must be //! met for a cached frame to be considered (if RXML.Frame.is_valid() //! is defined). They may be read directly after do_return() returns.
46c68f2000-08-12Martin Stjernholm //! The tag name is always the same. FIXME: These are ideas only; //! nothing is currently implemented and they might change //! arbitrarily.
ed81751999-12-11Martin Stjernholm 
8cb24d2000-02-13Martin Stjernholm constant FLAG_CACHE_DIFF_ARGS = 0x00010000;
ed81751999-12-11Martin Stjernholm //! If set, the arguments to the tag need not be the same (using //! equal()) as the cached args. constant FLAG_CACHE_DIFF_CONTENT = 0x00020000; //! If set, the content need not be the same. constant FLAG_CACHE_DIFF_RESULT_TYPE = 0x00040000; //! If set, the result type need not be the same. (Typically //! not useful unless cached_return() is used.)
8cb24d2000-02-13Martin Stjernholm constant FLAG_CACHE_DIFF_VARS = 0x00080000;
ed81751999-12-11Martin Stjernholm //! If set, the variables with external scope in vars (i.e. normally //! those that has been accessed with get_var()) need not have the //! same values (using equal()) as the actual variables.
46c68f2000-08-12Martin Stjernholm constant FLAG_CACHE_DIFF_TAG_INSTANCE = 0x00100000; //! If set, the tag in the source document needs to be the same, so //! the same frame may be used when the tag occurs in another context.
ed81751999-12-11Martin Stjernholm  constant FLAG_CACHE_EXECUTE_RESULT = 0x00200000;
91c8982000-03-11Martin Stjernholm //! If set, an exec array will be stored in the frame instead of the //! final result. On a cache hit it'll be executed to produce the //! result.
ed81751999-12-11Martin Stjernholm  class Frame
46c68f2000-08-12Martin Stjernholm //! A tag instance. A new frame is normally created for every parsed //! tag in the source document. It might be reused both when the //! document is requested again and when the tag is reevaluated in a //! loop, but it's not certain in either case. Therefore, be careful //! about using variable initializers.
ed81751999-12-11Martin Stjernholm { constant is_RXML_Frame = 1;
56532d1999-12-19Martin Stjernholm  constant thrown_at_unwind = 1;
ed81751999-12-11Martin Stjernholm  //! Interface. Frame up; //! The parent frame. This frame is either created from the content
91c8982000-03-11Martin Stjernholm  //! inside the up frame, or it's in an exec array produced by the up //! frame.
ed81751999-12-11Martin Stjernholm  Tag tag; //! The RXML.Tag object this frame was created from. int flags; //! Various bit flags that affect parsing. See the FLAG_* constants.
46c68f2000-08-12Martin Stjernholm  //! It's copied from Tag.flag when the frame is created.
ed81751999-12-11Martin Stjernholm  mapping(string:mixed) args;
46c68f2000-08-12Martin Stjernholm  //! The (parsed and evaluated) arguments passed to the tag. Set //! every time the frame is executed, before any frame callbacks are //! called. Not set for processing instruction (FLAG_PROC_INSTR)
24f9e82000-08-05Martin Stjernholm  //! tags.
ed81751999-12-11Martin Stjernholm  Type content_type; //! The type of the content.
0f998b2000-08-15Martin Stjernholm  mixed content = nil;
91c8982000-03-11Martin Stjernholm  //! The content, if any. Set before do_process() and do_return() are
46c68f2000-08-12Martin Stjernholm  //! called. Initialized to RXML.nil every time the frame executed.
ed81751999-12-11Martin Stjernholm  Type result_type;
46c68f2000-08-12Martin Stjernholm  //! The required result type. If it has a parser, it will affect how //! execution arrays are handled; see the return value for //! do_return() for details. //! //! This is set by the type inference from Tag.result_types before //! any frame callbacks are called. The frame may change this type, //! but it must produce a result value which matches it. The value //! is converted before being inserted into the parent content if //! necessary. An exception (which this frame can't catch) is thrown //! if conversion is impossible.
0f998b2000-08-15Martin Stjernholm  mixed result = nil;
46c68f2000-08-12Martin Stjernholm  //! The result, which is assumed to be either RXML.nil or a valid //! value according to result_type. The exec arrays returned by e.g.
91c8982000-03-11Martin Stjernholm  //! do_return() changes this. It may also be set directly.
46c68f2000-08-12Martin Stjernholm  //! Initialized to RXML.nil every time the frame executed. //! //! If result_type has a parser set, it will be used by do_return() //! etc before assigning to this variable. Thus it contains the //! value after any parsing and will not be parsed again.
ed81751999-12-11Martin Stjernholm  //!mapping(string:mixed) vars; //! Set this to introduce a new variable scope that will be active //! during parsing of the content and return values (but see also
146e342000-02-15Martin Stjernholm  //! FLAG_PARENT_SCOPE).
ed81751999-12-11Martin Stjernholm  //!string scope_name;
291ade2000-01-25Martin Stjernholm  //! The scope name for the variables. Must be set before the scope //! is used for the first time, and can't be changed after that.
ed81751999-12-11Martin Stjernholm  //!TagSet additional_tags; //! If set, the tags in this tag set will be used in addition to the //! tags inherited from the surrounding parser. The additional tags //! will in turn be inherited by subparsers. //!TagSet local_tags; //! If set, the tags in this tag set will be used in the parser for //! the content, instead of the one inherited from the surrounding //! parser. The tags are not inherited by subparsers.
51f88b2000-06-23Martin Stjernholm  //!string raw_tag_text; //! If this variable exists, it gets the raw text representation of //! the tag, if there is any. Note that it's after parsing of any //! splice argument.
291ade2000-01-25Martin Stjernholm  //!array do_enter (RequestID id);
91c8982000-03-11Martin Stjernholm  //!array do_process (RequestID id, void|mixed piece); //!array do_return (RequestID id);
291ade2000-01-25Martin Stjernholm  //! do_enter() is called first thing when processing the tag.
91c8982000-03-11Martin Stjernholm  //! do_process() is called after (some of) the content has been //! processed. do_return() is called lastly before leaving the tag.
291ade2000-01-25Martin Stjernholm  //! //! For tags that loops more than one time (see do_iterate): //! do_enter() is only called initially before the first call to
91c8982000-03-11Martin Stjernholm  //! do_iterate(). do_process() is called after each iteration. //! do_return() is called after the last call to do_process().
ed81751999-12-11Martin Stjernholm  //! //! The result_type variable is set to the type of result the parser
46c68f2000-08-12Martin Stjernholm  //! wants. The tag may change it; the value will then be converted //! to the type that the parser wants. If the result type is //! sequential, it's spliced into the surrounding content, otherwise //! it replaces the previous value of the content, if any. If the //! result is RXML.nil, it does not affect the surrounding content //! at all.
ed81751999-12-11Martin Stjernholm  //! //! Return values: //!
291ade2000-01-25Martin Stjernholm  //! array - A so-called execution array to be handled by the //! parser. The elements are processed in order, and have //! the following usage:
ed81751999-12-11Martin Stjernholm  //! //! string - Added or put into the result. If the result type has //! a parser, the string will be parsed with it before //! it's assigned to the result variable and passed on. //! RXML.Frame - Already initialized frame to process. Neither //! arguments nor content will be parsed. It's result is //! added or put into the result of this tag. //! mapping(string:mixed) - Fields to merge into the headers.
91c8982000-03-11Martin Stjernholm  //! FIXME: Not yet implemented.
ed81751999-12-11Martin Stjernholm  //! object - Treated as a file object to read in blocking or //! nonblocking mode. FIXME: Not yet implemented, details //! not decided. //! multiset(mixed) - Should only contain one element that'll be //! added or put into the result. Normally not necessary; //! assign it directly to the result variable instead.
51f88b2000-06-23Martin Stjernholm  //! propagate_tag() - Use a call to this function to propagate the //! tag to be handled by an overridden tag definition, if //! any exists. If this is used, it's probably necessary //! to define the raw_tag_text variable. For further //! details see the doc for propagate_tag() in this class.
ed81751999-12-11Martin Stjernholm  //!
291ade2000-01-25Martin Stjernholm  //! 0 - Do nothing special. Exits the tag when used from
91c8982000-03-11Martin Stjernholm  //! do_process() and FLAG_STREAM_RESULT is set.
291ade2000-01-25Martin Stjernholm  //! //! Note that the intended use is not to postparse by setting a //! parser on the result type, but instead to return an array with //! literal strings and RXML.Frame objects where parsing (or, more //! accurately, evaluation) needs to be done. //! //! If an array instead of a function is given, the array is handled
46c68f2000-08-12Martin Stjernholm  //! as above. If the result variable is RXML.nil (which it defaults //! to), content is used as result if it's of a compatible type.
291ade2000-01-25Martin Stjernholm  //!
c28dd22000-03-11Martin Nilsson  //! If there is no do_return() and the result from parsing the
46c68f2000-08-12Martin Stjernholm  //! content is not RXML.nil, it's assigned to or added to the //! content variable. Assignment is used if the content type is
c28dd22000-03-11Martin Nilsson  //! nonsequential, addition otherwise. Thus earlier values are //! simply overridden for nonsequential types.
ed81751999-12-11Martin Stjernholm  //!
9477392000-03-20Martin Stjernholm  //! Regarding do_process only: //! //! Normally the content variable is set to the parsed content of
46c68f2000-08-12Martin Stjernholm  //! the tag before do_process() is called. This may be RXML.nil if //! the content parsing didn't produce any result.
9477392000-03-20Martin Stjernholm  //!
ed81751999-12-11Martin Stjernholm  //! piece is used when the tag is operating in streaming mode (i.e. //! FLAG_STREAM_CONTENT is set). It's then set to each successive //! part of the content in the stream, and the content variable is
91c8982000-03-11Martin Stjernholm  //! never touched. do_process() is also called "normally" with no
ed81751999-12-11Martin Stjernholm  //! piece argument afterwards. Note that tags that support streaming //! mode might still be used nonstreaming (it might also vary //! between iterations). //!
91c8982000-03-11Martin Stjernholm  //! As long as FLAG_STREAM_RESULT is set, do_process() will be //! called repeatedly until it returns 0. It's only the result piece //! from the execution array that is propagated after each turn; the
ed81751999-12-11Martin Stjernholm  //! result variable only accumulates all these pieces.
291ade2000-01-25Martin Stjernholm  //!int do_iterate (RequestID id); //! Controls the number of passes in the tag done by the parser. In //! every pass, the content of the tag (if any) is processed, then
91c8982000-03-11Martin Stjernholm  //! do_process() is called.
291ade2000-01-25Martin Stjernholm  //! //! Before doing any pass, do_iterate() is called. If the return //! value is nonzero, that many passes is done, then do_iterate() is //! called again and the process repeats. If the return value is //! zero, the tag exits and the value in result is used in the //! surrounding content as described above.
ed81751999-12-11Martin Stjernholm  //!
291ade2000-01-25Martin Stjernholm  //! The most common way to iterate is to do the setup before every //! pass (e.g. setup the variable scope) and return 1 to do one pass //! through the content. This will repeat until 0 is returned. //! //! If do_iterate is a positive integer, that many passes is done
a21fcb2000-02-08Martin Nilsson  //! and then the tag exits. If do_iterate is zero no pass is done. //! If do_iterate is missing, one pass is done.
ed81751999-12-11Martin Stjernholm 
291ade2000-01-25Martin Stjernholm  //!int|function(RequestID:int) is_valid;
ed81751999-12-11Martin Stjernholm  //! When defined, the frame may be cached. First the name of the tag //! must be the same. Then the conditions specified by the cache //! bits in flag are checked. Then, if this is a function, it's //! called. If it returns 1, the frame is reused. FIXME: Not yet //! implemented.
c6245b1999-12-31Martin Stjernholm  optional array cached_return (Context ctx, void|mixed piece);
ed81751999-12-11Martin Stjernholm  //! If defined, this will be called to get the value from a cached //! frame (that's still valid) instead of using the cached result. //! It's otherwise handled like do_return(). Note that the cached //! frame may be used from several threads. FIXME: Not yet //! implemented. //! Services.
ffa6932000-02-20Martin Stjernholm  local mixed get_var (string var, void|string scope_name, void|Type want_type) //! A wrapper for easy access to RXML.Context.get_var(). { return get_context()->get_var (var, scope_name, want_type); } local mixed set_var (string var, mixed val, void|string scope_name) //! A wrapper for easy access to RXML.Context.set_var(). { return get_context()->set_var (var, val, scope_name); } local void delete_var (string var, void|string scope_name) //! A wrapper for easy access to RXML.Context.delete_var(). { get_context()->delete_var (var, scope_name); }
5ed0132000-02-13Martin Stjernholm  void run_error (string msg, mixed... args)
ffa6932000-02-20Martin Stjernholm  //! A wrapper for easy access to RXML.run_error().
ed81751999-12-11Martin Stjernholm  {
5ed0132000-02-13Martin Stjernholm  _run_error (msg, @args);
ed81751999-12-11Martin Stjernholm  }
5ed0132000-02-13Martin Stjernholm  void parse_error (string msg, mixed... args)
ffa6932000-02-20Martin Stjernholm  //! A wrapper for easy access to RXML.parse_error().
291ade2000-01-25Martin Stjernholm  {
5ed0132000-02-13Martin Stjernholm  _parse_error (msg, @args);
291ade2000-01-25Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm  void terminate() //! Makes the parser abort. The data parsed so far will be returned. //! Does not return; throws a special exception instead. {
8cb24d2000-02-13Martin Stjernholm  fatal_error ("FIXME\n");
ed81751999-12-11Martin Stjernholm  } void suspend() //! Used together with resume() for nonblocking mode. May be called
91c8982000-03-11Martin Stjernholm  //! from any frame callback to suspend the parser: The parser will //! just stop, leaving the context intact. If it returns, the parser //! is used in a place that doesn't support nonblocking, so just go //! ahead and block.
ed81751999-12-11Martin Stjernholm  {
8cb24d2000-02-13Martin Stjernholm  fatal_error ("FIXME\n");
ed81751999-12-11Martin Stjernholm  } void resume() //! Makes the parser continue where it left off. The function that //! called suspend() will be called again. {
8cb24d2000-02-13Martin Stjernholm  fatal_error ("FIXME\n");
ed81751999-12-11Martin Stjernholm  }
cf3c902000-02-04Martin Stjernholm  mapping(string:Tag) get_plugins() //! Returns the plugins registered for this tag, which is assumed to //! be a socket tag, i.e. to have FLAG_SOCKET_TAG set (see //! Tag.plugin_name for details). Indices are the plugin_name values //! for the plugin Tag objects, values are the plugin objects //! themselves. Don't be destructive on the returned mapping. { #ifdef MODULE_DEBUG if (!(flags & FLAG_SOCKET_TAG))
8cb24d2000-02-13Martin Stjernholm  fatal_error ("This tag is not a socket tag.\n");
cf3c902000-02-04Martin Stjernholm #endif
24f9e82000-08-05Martin Stjernholm  return get_context()->tag_set->get_plugins (tag->name, tag->flags & FLAG_PROC_INSTR);
cf3c902000-02-04Martin Stjernholm  }
51f88b2000-06-23Martin Stjernholm  Frame|string propagate_tag (void|mapping(string:string) args, void|string content) //! This function is intended to be used in the execution array from //! do_return() etc to propagate the tag to the next overridden tag //! definition, if any exists. It either returns a frame from the //! overridden tag or, if no overridden tag exists, a string //! containing a formatted tag (which requires that the result type //! supports formatted tags, i.e. has a working format_tag() //! function). If args and content are given, they will be used in //! the tag after parsing, otherwise the raw_tag_text variable is //! used, which must have a string value. { Context ctx = get_context();
2e0a6d2000-07-06Martin Stjernholm  object(Tag) overridden = ctx->tag_set->get_overridden_tag (tag);
51f88b2000-06-23Martin Stjernholm  if (arrayp (overridden)) fatal_error ("Getting frames for low level tags are currently not implemented.\n"); if (overridden) { Frame frame; if (!args) { #ifdef MODULE_DEBUG if (zero_type (this_object()->raw_tag_text)) fatal_error ("The variable raw_tag_text must be defined.\n"); if (!stringp (this_object()->raw_tag_text)) fatal_error ("raw_tag_text must have a string value.\n"); #endif Parser_HTML() ->add_container (tag->name, lambda (object p, mapping(string:string) a, string c) { args = a; content = c; return ({}); }) ->finish (this_object()->raw_tag_text); } frame = overridden (args, content || ""); frame->flags |= FLAG_UNPARSED; return frame; } else if (args) return result_type->format_tag (tag, args, content); else { #ifdef MODULE_DEBUG if (zero_type (this_object()->raw_tag_text)) fatal_error ("The variable raw_tag_text must be defined.\n"); if (!stringp (this_object()->raw_tag_text)) fatal_error ("raw_tag_text must have a string value.\n"); #endif
24f9e82000-08-05Martin Stjernholm  if (flags & FLAG_PROC_INSTR) return this_object()->raw_tag_text; else {
51f88b2000-06-23Martin Stjernholm #ifdef MODULE_DEBUG
24f9e82000-08-05Martin Stjernholm  if (mixed err = catch {
51f88b2000-06-23Martin Stjernholm #endif
24f9e82000-08-05Martin Stjernholm  return t_xml (PEnt)->eval (this_object()->raw_tag_text, ctx, empty_tag_set); #ifdef MODULE_DEBUG }) { if (objectp (err) && ([object] err)->thrown_at_unwind) fatal_error ("Can't save parser state when evaluating arguments.\n"); throw_fatal (err); } #endif }
51f88b2000-06-23Martin Stjernholm  } }
ed81751999-12-11Martin Stjernholm  // Internals.
e86f2d2000-02-15Martin Stjernholm  mixed _exec_array (TagSetParser parser, array exec, int parent_scope)
ed81751999-12-11Martin Stjernholm  {
56532d1999-12-19Martin Stjernholm  Frame this = this_object();
c6245b1999-12-31Martin Stjernholm  Context ctx = parser->context;
ed81751999-12-11Martin Stjernholm  int i = 0;
46c68f2000-08-12Martin Stjernholm  mixed res = nil;
ed81751999-12-11Martin Stjernholm  Parser subparser = 0; mixed err = catch {
e86f2d2000-02-15Martin Stjernholm  if (parent_scope) LEAVE_SCOPE (ctx, this);
ed81751999-12-11Martin Stjernholm  for (; i < sizeof (exec); i++) {
46c68f2000-08-12Martin Stjernholm  mixed elem = exec[i], piece = nil;
ed81751999-12-11Martin Stjernholm  switch (sprintf ("%t", elem)) { case "string": if (result_type->_parser_prog == PNone) piece = elem; else {
0ebc9d2000-02-15Martin Stjernholm  subparser = result_type->get_parser (ctx, 0, parser);
56532d1999-12-19Martin Stjernholm  subparser->finish ([string] elem); // Might unwind. piece = subparser->eval(); // Might unwind.
ed81751999-12-11Martin Stjernholm  subparser = 0; } break; case "mapping":
8cb24d2000-02-13Martin Stjernholm  fatal_error ("Header mappings not yet implemented.\n");
ed81751999-12-11Martin Stjernholm  break; case "multiset":
56532d1999-12-19Martin Stjernholm  if (sizeof ([multiset] elem) == 1) piece = ((array) elem)[0]; else if (sizeof ([multiset] elem) > 1)
8cb24d2000-02-13Martin Stjernholm  fatal_error (sizeof ([multiset] elem) + " values in multiset in exec array.\n"); else fatal_error ("No value in multiset in exec array.\n");
ed81751999-12-11Martin Stjernholm  break; default:
5a455b2000-02-13Martin Stjernholm  if (objectp (elem)) // Can't count on that sprintf ("%t", ...) on an object // returns "object". if (([object] elem)->is_RXML_Frame) {
a85a952000-02-13Martin Stjernholm  ([object(Frame)] elem)->_eval (parser); // Might unwind.
5a455b2000-02-13Martin Stjernholm  piece = ([object(Frame)] elem)->result; } else if (([object] elem)->is_RXML_Parser) { // The subparser above unwound. ([object(Parser)] elem)->finish(); // Might unwind. piece = ([object(Parser)] elem)->eval(); // Might unwind. } else
8cb24d2000-02-13Martin Stjernholm  fatal_error ("File objects not yet implemented.\n");
5a455b2000-02-13Martin Stjernholm  else
8cb24d2000-02-13Martin Stjernholm  fatal_error ("Invalid type %t in exec array.\n", elem);
ed81751999-12-11Martin Stjernholm  } if (result_type->sequential) res += piece;
46c68f2000-08-12Martin Stjernholm  else if (piece != nil) result = res = piece;
ed81751999-12-11Martin Stjernholm  } if (result_type->sequential) result += res;
e86f2d2000-02-15Martin Stjernholm  if (parent_scope) ENTER_SCOPE (ctx, this);
ed81751999-12-11Martin Stjernholm  return res; };
e86f2d2000-02-15Martin Stjernholm  if (parent_scope) ENTER_SCOPE (ctx, this);
ed81751999-12-11Martin Stjernholm  if (result_type->sequential) result += res;
56532d1999-12-19Martin Stjernholm  if (objectp (err) && ([object] err)->thrown_at_unwind) { mapping(string:mixed)|mapping(object:array) ustate;
33712a2000-03-13Martin Stjernholm  if ((ustate = ctx->unwind_state) && !zero_type (ustate->stream_piece)) {
ed81751999-12-11Martin Stjernholm  // Subframe wants to stream. Update stream_piece and send it on.
23a0882000-08-12Martin Stjernholm  if (result_type->encoding_type ? result_type->encoding_type != parser->type->encoding_type : result_type != parser->type) res = parser->type->encode (res, result_type);
ed81751999-12-11Martin Stjernholm  if (result_type->sequential) ustate->stream_piece = res + ustate->stream_piece;
46c68f2000-08-12Martin Stjernholm  else if (ustate->stream_piece == nil)
ed81751999-12-11Martin Stjernholm  ustate->stream_piece = res;
33712a2000-03-13Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm  ustate->exec_left = exec[i..]; // Left to execute. if (subparser) // Replace the string with the subparser object so that we'll
56532d1999-12-19Martin Stjernholm  // continue in it later. It's done here to keep the original // exec array untouched. ([array] ustate->exec_left)[0] = subparser;
8cb24d2000-02-13Martin Stjernholm  throw (err);
ed81751999-12-11Martin Stjernholm  }
8cb24d2000-02-13Martin Stjernholm  throw_fatal (err);
ed81751999-12-11Martin Stjernholm  }
0ebc9d2000-02-15Martin Stjernholm  private void _handle_runtime_tags (Context ctx, TagSetParser parser)
2bd21a2000-01-05Martin Stjernholm  { // FIXME: PCode handling.
24f9e82000-08-05Martin Stjernholm  array(Tag) arr_add_tags = ctx->new_runtime_tags->added_tags(); array(string) arr_rem_tags = ctx->new_runtime_tags->removed_tags(); array(string) arr_rem_pi_tags = ctx->new_runtime_tags->removed_pi_tags();
2bd21a2000-01-05Martin Stjernholm  for (Parser p = parser; p; p = p->_parent)
9502852000-02-15Martin Stjernholm  if (p->tag_set_eval && !p->_local_tag_set && p->add_runtime_tag) {
2bd21a2000-01-05Martin Stjernholm  foreach (arr_add_tags, Tag tag) ([object(TagSetParser)] p)->add_runtime_tag (tag);
87fb7e2000-03-25Martin Stjernholm  foreach (arr_rem_tags, string tag)
2bd21a2000-01-05Martin Stjernholm  ([object(TagSetParser)] p)->remove_runtime_tag (tag);
24f9e82000-08-05Martin Stjernholm  foreach (arr_rem_pi_tags, string tag) ([object(TagSetParser)] p)->remove_runtime_tag (tag, 1);
2bd21a2000-01-05Martin Stjernholm  }
24f9e82000-08-05Martin Stjernholm  ctx->runtime_tags = ctx->new_runtime_tags->filter_tags (ctx->runtime_tags);
0ebc9d2000-02-15Martin Stjernholm  ctx->new_runtime_tags = 0;
2bd21a2000-01-05Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm  void _eval (TagSetParser parser, void|mapping(string:string) raw_args, void|string raw_content) // Note: It might be somewhat tricky to override this function.
51f88b2000-06-23Martin Stjernholm  // Note: Might be destructive on raw_args.
ed81751999-12-11Martin Stjernholm  {
56532d1999-12-19Martin Stjernholm  Frame this = this_object();
ed81751999-12-11Martin Stjernholm  Context ctx = parser->context;
b483382000-06-30Martin Stjernholm  RequestID id = ctx->id;
ed81751999-12-11Martin Stjernholm 
c6245b1999-12-31Martin Stjernholm  // Unwind state data: //raw_content
49897a2000-02-13Martin Stjernholm #define EVSTAT_BEGIN 0 #define EVSTAT_ENTERED 1 #define EVSTAT_LAST_ITER 2 #define EVSTAT_ITER_DONE 3 int eval_state = EVSTAT_BEGIN;
291ade2000-01-25Martin Stjernholm  int iter;
ed81751999-12-11Martin Stjernholm  Parser subparser; mixed piece; array exec;
f02d002000-03-18Martin Stjernholm  TagSet orig_tag_set; // Flags that we added additional_tags to ctx->tag_set.
c6245b1999-12-31Martin Stjernholm  //ctx->new_runtime_tags
ed81751999-12-11Martin Stjernholm 
8cb24d2000-02-13Martin Stjernholm #define PRE_INIT_ERROR(X) (ctx->frame = this, fatal_error (X))
2bd21a2000-01-05Martin Stjernholm #ifdef DEBUG // Internal sanity checks. if (ctx != get_context()) PRE_INIT_ERROR ("Internal error: Context not current.\n");
1b2b752000-01-07Martin Stjernholm  if (!parser->tag_set_eval)
2bd21a2000-01-05Martin Stjernholm  PRE_INIT_ERROR ("Internal error: Calling _eval() with non-tag set parser.\n"); #endif #ifdef MODULE_DEBUG if (ctx->new_runtime_tags) PRE_INIT_ERROR ("Looks like Context.add_runtime_tag() or " "Context.remove_runtime_tag() was used outside any parser.\n"); #endif
76cbfb2000-02-04Martin Stjernholm  if (flags & FLAG_UNPARSED) { #ifdef DEBUG if (raw_args || raw_content) PRE_INIT_ERROR ("Internal error: raw_args or raw_content given for " "unparsed frame.\n"); #endif raw_args = args, args = 0;
46c68f2000-08-12Martin Stjernholm  raw_content = content, content = nil;
76cbfb2000-02-04Martin Stjernholm #ifdef MODULE_DEBUG if (!stringp (raw_content)) PRE_INIT_ERROR ("Content is not a string in unparsed tag frame.\n"); #endif }
ed81751999-12-11Martin Stjernholm  if (array state = ctx->unwind_state && ctx->unwind_state[this]) { #ifdef DEBUG if (!up) PRE_INIT_ERROR ("Internal error: Resuming frame without up pointer.\n"); if (raw_args || raw_content) PRE_INIT_ERROR ("Internal error: Can't feed new arguments or content " "when resuming parse.\n"); #endif
56532d1999-12-19Martin Stjernholm  object ignored;
f02d002000-03-18Martin Stjernholm  [ignored, eval_state, iter, raw_content, subparser, piece, exec, orig_tag_set,
2bd21a2000-01-05Martin Stjernholm  ctx->new_runtime_tags] = state;
ed81751999-12-11Martin Stjernholm  m_delete (ctx->unwind_state, this); if (!sizeof (ctx->unwind_state)) ctx->unwind_state = 0; } else { #ifdef MODULE_DEBUG if (up && up != ctx->frame) PRE_INIT_ERROR ("Reuse of frame in different context.\n"); #endif up = ctx->frame;
23a0882000-08-12Martin Stjernholm  piece = nil;
ffa6932000-02-20Martin Stjernholm  if (++ctx->frame_depth >= ctx->max_frame_depth) { ctx->frame = this; ctx->frame_depth--; _run_error ("Too deep recursion -- exceeding %d nested tags.\n", ctx->max_frame_depth); }
ed81751999-12-11Martin Stjernholm  }
2bd21a2000-01-05Martin Stjernholm 
ed81751999-12-11Martin Stjernholm #undef PRE_INIT_ERROR ctx->frame = this;
b483382000-06-30Martin Stjernholm  do { // Target for breaks (goto wouldn't be all bad, really). if (tag) {
24f9e82000-08-05Martin Stjernholm  if ((raw_args || args || ([]))->help) {
b483382000-06-30Martin Stjernholm  TRACE_ENTER ("tag &lt;" + tag->name + " help&gt;", tag); string help = id->conf->find_tag_doc (tag->name, id); TRACE_LEAVE (""); ctx->handle_exception ( // Will throw if necessary. Backtrace ("help", help, ctx), parser); break;
49897a2000-02-13Martin Stjernholm  }
b483382000-06-30Martin Stjernholm  TRACE_ENTER("tag &lt;" + tag->name + "&gt;", tag); #ifdef MODULE_LEVEL_SECURITY if (id->conf->check_security (tag, id, id->misc->seclevel)) { TRACE_LEAVE("access denied"); break; } #endif } if (raw_args) {
24f9e82000-08-05Martin Stjernholm #ifdef MODULE_DEBUG if (flags & FLAG_PROC_INSTR) fatal_error ("Can't pass arguments to a processing instruction tag.\n"); #endif
b483382000-06-30Martin Stjernholm  if (sizeof (raw_args)) { // Note: Code duplication in Tag.eval_args(). mapping(string:Type) atypes = raw_args & tag->req_arg_types; if (sizeof (atypes) < sizeof (tag->req_arg_types)) { array(string) missing = sort (indices (tag->req_arg_types - atypes)); parse_error ("Required " + (sizeof (missing) > 1 ? "arguments " + String.implode_nicely (missing) + " are" : "argument " + missing[0] + " is") + " missing.\n"); } atypes += raw_args & tag->opt_arg_types;
c159ec2000-02-04Martin Stjernholm #ifdef MODULE_DEBUG
b483382000-06-30Martin Stjernholm  if (mixed err = catch {
c159ec2000-02-04Martin Stjernholm #endif
b483382000-06-30Martin Stjernholm  foreach (indices (raw_args), string arg) raw_args[arg] = (atypes[arg] || tag->def_arg_type)-> eval (raw_args[arg], ctx, 0, parser, 1); // Should not unwind.
c159ec2000-02-04Martin Stjernholm #ifdef MODULE_DEBUG
b483382000-06-30Martin Stjernholm  }) { if (objectp (err) && ([object] err)->thrown_at_unwind) fatal_error ("Can't save parser state when evaluating arguments.\n"); throw_fatal (err); }
710b482000-02-07Martin Stjernholm #endif
b483382000-06-30Martin Stjernholm  } args = raw_args;
49897a2000-02-13Martin Stjernholm  } #ifdef MODULE_DEBUG
24f9e82000-08-05Martin Stjernholm  else if (!args && !(flags & FLAG_PROC_INSTR)) fatal_error ("args not set.\n");
ed81751999-12-11Martin Stjernholm #endif
b483382000-06-30Martin Stjernholm  if (TagSet add_tags = raw_content && [object(TagSet)] this->additional_tags) { TagSet tset = ctx->tag_set; if (!tset->has_effective_tags (add_tags)) { int hash = HASH_INT2 (tset->id_number, add_tags->id_number); orig_tag_set = tset; TagSet local_ts; if (!(local_ts = local_tag_set_cache[hash])) { local_ts = TagSet (add_tags->name + "+" + orig_tag_set->name); local_ts->imported = ({add_tags, orig_tag_set}); local_tag_set_cache[hash] = local_ts; // Race, but it doesn't matter. } ctx->tag_set = local_ts;
87fb7e2000-03-25Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm  }
b483382000-06-30Martin Stjernholm  if (!result_type) {
a85a952000-02-13Martin Stjernholm #ifdef MODULE_DEBUG
b483382000-06-30Martin Stjernholm  if (!tag) fatal_error ("result_type not set in Frame object %O, " "and it has no Tag object to use for inferring it.\n", this_object());
a85a952000-02-13Martin Stjernholm #endif
b483382000-06-30Martin Stjernholm  Type ptype = parser->type; foreach (tag->result_types, Type rtype) if (ptype == rtype) { result_type = rtype; break; } else if (ptype->subtype_of (rtype)) { result_type = ptype (rtype->_parser_prog); break; } if (!result_type) // Sigh.. parse_error ( "Tag returns " + String.implode_nicely ([array(string)] tag->result_types->name, "or") + " but " + [string] parser->type->name + " is expected.\n"); } if (!content_type) {
a85a952000-02-13Martin Stjernholm #ifdef MODULE_DEBUG
b483382000-06-30Martin Stjernholm  if (!tag) fatal_error ("content_type not set in Frame object %O, " "and it has no Tag object to use for inferring it.\n", this_object());
a85a952000-02-13Martin Stjernholm #endif
b483382000-06-30Martin Stjernholm  content_type = tag->content_type; if (content_type == t_same) content_type = result_type (content_type->_parser_prog); } if (raw_content) content = content_type->empty_value; mixed err = catch { switch (eval_state) { case EVSTAT_BEGIN: if (array|function(RequestID:array) do_enter = [array|function(RequestID:array)] this->do_enter) { if (!exec) { exec = arrayp (do_enter) ? [array] do_enter : ([function(RequestID:array)] do_enter) ( id); // Might unwind. if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); } if (exec) { if (!(flags & FLAG_PARENT_SCOPE)) ENTER_SCOPE (ctx, this); mixed res = _exec_array (parser, exec, 0); // Might unwind. if (flags & FLAG_STREAM_RESULT) {
291ade2000-01-25Martin Stjernholm #ifdef DEBUG
b483382000-06-30Martin Stjernholm  if (ctx->unwind_state) fatal_error ("Internal error: Clobbering unwind_state " "to do streaming.\n");
46c68f2000-08-12Martin Stjernholm  if (piece != nil)
b483382000-06-30Martin Stjernholm  fatal_error ("Internal error: Thanks, we think about how nice " "it must be to play the harmonica...\n");
291ade2000-01-25Martin Stjernholm #endif
23a0882000-08-12Martin Stjernholm  if (result_type->encoding_type ? result_type->encoding_type != parser->type->encoding_type : result_type != parser->type) res = parser->type->encode (res, result_type);
b483382000-06-30Martin Stjernholm  ctx->unwind_state = (["stream_piece": res]); throw (this); } exec = 0;
49897a2000-02-13Martin Stjernholm  }
291ade2000-01-25Martin Stjernholm  }
b483382000-06-30Martin Stjernholm  eval_state = EVSTAT_ENTERED; /* Fall through. */ case EVSTAT_ENTERED: case EVSTAT_LAST_ITER: do { if (eval_state != EVSTAT_LAST_ITER) { int|function(RequestID:int) do_iterate = [int|function(RequestID:int)] this->do_iterate; if (intp (do_iterate)) { iter = [int] do_iterate || 1; eval_state = EVSTAT_LAST_ITER; } else { iter = (/*[function(RequestID:int)]HMM*/ do_iterate) ( id); // Might unwind. if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); if (!iter) eval_state = EVSTAT_LAST_ITER; }
0ebc9d2000-02-15Martin Stjernholm  }
b483382000-06-30Martin Stjernholm  ENTER_SCOPE (ctx, this); for (; iter > 0; iter--) {
0f998b2000-08-15Martin Stjernholm  if (raw_content && raw_content != "") if (flags & FLAG_EMPTY_ELEMENT) parse_error ("This tag doesn't handle content.\n"); else { // Got nested parsing to do. int finished = 0; if (!subparser) { // The nested content is not yet parsed. if (this->local_tags) { subparser = content_type->get_parser ( ctx, [object(TagSet)] this->local_tags, parser); subparser->_local_tag_set = 1; } else subparser = content_type->get_parser (ctx, 0, parser); subparser->finish (raw_content); // Might unwind. finished = 1;
b483382000-06-30Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm 
0f998b2000-08-15Martin Stjernholm  do { if (flags & FLAG_STREAM_CONTENT && subparser->read) { // Handle a stream piece. // Squeeze out any free text from the subparser first. mixed res = subparser->read(); if (content_type->sequential) piece = res + piece; else if (piece == nil) piece = res; if (piece != nil) { array|function(RequestID,void|mixed:array) do_process; if ((do_process = [array|function(RequestID,void|mixed:array)] this->do_process) && !arrayp (do_process)) { if (!exec) { exec = do_process (id, piece); // Might unwind. if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); } if (exec) { ENTER_SCOPE (ctx, this); mixed res = _exec_array ( parser, exec, flags & FLAG_PARENT_SCOPE); // Might unwind. if (flags & FLAG_STREAM_RESULT) {
ed81751999-12-11Martin Stjernholm #ifdef DEBUG
0f998b2000-08-15Martin Stjernholm  if (!zero_type (ctx->unwind_state->stream_piece)) fatal_error ("Internal error: Clobbering " "unwind_state->stream_piece.\n");
ed81751999-12-11Martin Stjernholm #endif
0f998b2000-08-15Martin Stjernholm  if (result_type->encoding_type ? result_type->encoding_type != parser->type->encoding_type : result_type != parser->type) res = parser->type->encode (res, result_type); ctx->unwind_state->stream_piece = res; throw (this); } exec = 0; } else if (flags & FLAG_STREAM_RESULT) { // do_process() finished the stream. // Ignore remaining content. ctx->unwind_state = 0; piece = nil; break;
b483382000-06-30Martin Stjernholm  }
49897a2000-02-13Martin Stjernholm  }
0f998b2000-08-15Martin Stjernholm  piece = nil;
49897a2000-02-13Martin Stjernholm  }
0f998b2000-08-15Martin Stjernholm  if (finished) break;
ed81751999-12-11Martin Stjernholm  }
0f998b2000-08-15Martin Stjernholm  else { // The frame doesn't handle streamed content. piece = nil; if (finished) { mixed res = subparser->eval(); // Might unwind. if (content_type->sequential) content += res; else if (res != nil) content = res; break; }
b483382000-06-30Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm 
0f998b2000-08-15Martin Stjernholm  subparser->finish(); // Might unwind. finished = 1; } while (1); // Only loops when an unwound subparser has been recovered. subparser = 0; }
b483382000-06-30Martin Stjernholm  if (array|function(RequestID,void|mixed:array) do_process = [array|function(RequestID,void|mixed:array)] this->do_process) { if (!exec) { exec = arrayp (do_process) ? [array] do_process : ([function(RequestID,void|mixed:array)] do_process) ( id); // Might unwind. if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); } if (exec) { ENTER_SCOPE (ctx, this); mixed res = _exec_array ( parser, exec, flags & FLAG_PARENT_SCOPE); // Might unwind. if (flags & FLAG_STREAM_RESULT) {
ed81751999-12-11Martin Stjernholm #ifdef DEBUG
b483382000-06-30Martin Stjernholm  if (ctx->unwind_state) fatal_error ("Internal error: Clobbering unwind_state " "to do streaming.\n");
46c68f2000-08-12Martin Stjernholm  if (piece != nil)
b483382000-06-30Martin Stjernholm  fatal_error ("Internal error: Thanks, we think about how nice " "it must be to play the harmonica...\n");
ed81751999-12-11Martin Stjernholm #endif
23a0882000-08-12Martin Stjernholm  if (result_type->encoding_type ? result_type->encoding_type != parser->type->encoding_type : result_type != parser->type) res = parser->type->encode (res, result_type);
b483382000-06-30Martin Stjernholm  ctx->unwind_state = (["stream_piece": res]); throw (this); } exec = 0;
49897a2000-02-13Martin Stjernholm  } }
ed81751999-12-11Martin Stjernholm 
b483382000-06-30Martin Stjernholm  } } while (eval_state != EVSTAT_LAST_ITER); /* Fall through. */ case EVSTAT_ITER_DONE: if (array|function(RequestID:array) do_return = [array|function(RequestID:array)] this->do_return) { eval_state = EVSTAT_ITER_DONE; // Only need to record this state here. if (!exec) { exec = arrayp (do_return) ? [array] do_return : ([function(RequestID:array)] do_return) (id); // Might unwind. if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); } if (exec) { ENTER_SCOPE (ctx, this);
e86f2d2000-02-15Martin Stjernholm  _exec_array (parser, exec, flags & FLAG_PARENT_SCOPE); // Might unwind. exec = 0;
49897a2000-02-13Martin Stjernholm  }
b483382000-06-30Martin Stjernholm  }
46c68f2000-08-12Martin Stjernholm  else if (result == nil && !(flags & FLAG_EMPTY_ELEMENT))
b483382000-06-30Martin Stjernholm  if (result_type->_parser_prog == PNone) { if (content_type->subtype_of (result_type)) result = content; } else if (stringp (content_type)) { eval_state = EVSTAT_ITER_DONE; // Only need to record this state here. if (!exec) exec = ({content}); _exec_array (parser, exec, flags & FLAG_PARENT_SCOPE); // Might unwind. exec = 0; } LEAVE_SCOPE (ctx, this); }
f997202000-01-18Martin Stjernholm 
b483382000-06-30Martin Stjernholm  if (ctx->new_runtime_tags) _handle_runtime_tags (ctx, parser); };
ed81751999-12-11Martin Stjernholm 
b483382000-06-30Martin Stjernholm  ctx->frame_depth--;
ffa6932000-02-20Martin Stjernholm 
b483382000-06-30Martin Stjernholm  if (err) { LEAVE_SCOPE (ctx, this); string action; if (objectp (err) && ([object] err)->thrown_at_unwind) { mapping(string:mixed)|mapping(object:array) ustate = ctx->unwind_state; if (!ustate) ustate = ctx->unwind_state = ([]);
ed81751999-12-11Martin Stjernholm #ifdef DEBUG
b483382000-06-30Martin Stjernholm  if (ustate[this]) fatal_error ("Internal error: Frame already has an unwind state.\n");
ed81751999-12-11Martin Stjernholm #endif
b483382000-06-30Martin Stjernholm  if (ustate->exec_left) { exec = [array] ustate->exec_left; m_delete (ustate, "exec_left");
56532d1999-12-19Martin Stjernholm  }
b483382000-06-30Martin Stjernholm  if (err == this || exec && sizeof (exec) && err == exec[0]) // This frame or a frame in the exec array wants to stream. if (parser->unwind_safe) { // Rethrow to continue in parent since we've already done // the appropriate do_process stuff in this frame in // either case. if (err == this) err = 0; if (orig_tag_set) ctx->tag_set = orig_tag_set, orig_tag_set = 0; action = "break"; } else { // Can't stream since the parser isn't unwind safe. Just // continue. m_delete (ustate, "stream_piece"); action = "continue"; } else if (!zero_type (ustate->stream_piece)) { // Got a stream piece from a subframe. We handle it above; // store the state and tail recurse. piece = ustate->stream_piece;
56532d1999-12-19Martin Stjernholm  m_delete (ustate, "stream_piece"); action = "continue";
ed81751999-12-11Martin Stjernholm  }
b483382000-06-30Martin Stjernholm  else action = "break"; // Some other reason - back up to the top.
ed81751999-12-11Martin Stjernholm 
b483382000-06-30Martin Stjernholm  ustate[this] = ({err, eval_state, iter, raw_content, subparser, piece, exec, orig_tag_set, ctx->new_runtime_tags});
0f998b2000-08-15Martin Stjernholm  TRACE_LEAVE (action);
b483382000-06-30Martin Stjernholm  } else {
0f998b2000-08-15Martin Stjernholm  TRACE_LEAVE ("exception");
b483382000-06-30Martin Stjernholm  ctx->handle_exception (err, parser); // Will rethrow unknown errors.
46c68f2000-08-12Martin Stjernholm  result = nil;
b483382000-06-30Martin Stjernholm  action = "return"; }
ed81751999-12-11Martin Stjernholm 
b483382000-06-30Martin Stjernholm  switch (action) { case "break": // Throw and handle in parent frame.
56532d1999-12-19Martin Stjernholm #ifdef MODULE_DEBUG
b483382000-06-30Martin Stjernholm  if (!parser->unwind_state) fatal_error ("Trying to unwind inside a parser that isn't unwind safe.\n");
56532d1999-12-19Martin Stjernholm #endif
b483382000-06-30Martin Stjernholm  throw (this); case "continue": // Continue in this frame through tail recursion. _eval (parser); return; case "return": // A normal return. break; default: fatal_error ("Internal error: Don't you come here and %O on me!\n", action); }
ed81751999-12-11Martin Stjernholm  }
b483382000-06-30Martin Stjernholm  else
0f998b2000-08-15Martin Stjernholm  TRACE_LEAVE ("");
b483382000-06-30Martin Stjernholm  } while (0); // Breaks go here.
ed81751999-12-11Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  if (orig_tag_set) ctx->tag_set = orig_tag_set;
01e43b2000-01-14Martin Stjernholm  ctx->frame = up;
ed81751999-12-11Martin Stjernholm  }
f02d002000-03-18Martin Stjernholm  MARK_OBJECT;
26ff092000-01-21Martin Stjernholm 
ed81751999-12-11Martin Stjernholm  string _sprintf() {
f02d002000-03-18Martin Stjernholm  return "RXML.Frame(" + (tag && [string] tag->name) + ")" + OBJ_COUNT;
ed81751999-12-11Martin Stjernholm  } }
49897a2000-02-13Martin Stjernholm // Global services.
5ad5292000-03-09Martin Stjernholm //! Shortcuts to some common functions in the current context. mixed get_var (string var, void|string scope_name, void|Type want_type) {return get_context()->get_var (var, scope_name, want_type);} mixed user_get_var (string var, void|string scope_name, void|Type want_type) {return get_context()->user_get_var (var, scope_name, want_type);} mixed set_var (string var, mixed val, void|string scope_name) {return get_context()->set_var (var, val, scope_name);} mixed user_set_var (string var, mixed val, void|string scope_name) {return get_context()->user_set_var (var, val, scope_name);} void delete_var (string var, void|string scope_name) {get_context()->delete_var (var, scope_name);} void user_delete_var (string var, void|string scope_name) {get_context()->user_delete_var (var, scope_name);}
5ed0132000-02-13Martin Stjernholm void run_error (string msg, mixed... args)
8cb24d2000-02-13Martin Stjernholm //! Throws an RXML run error with a dump of the parser stack in the //! current context. This is intended to be used by tags for errors //! that can occur during normal operation, such as when the //! connection to an SQL server fails.
49897a2000-02-13Martin Stjernholm {
8cb24d2000-02-13Martin Stjernholm  if (sizeof (args)) msg = sprintf (msg, @args);
51f88b2000-06-23Martin Stjernholm  array bt = backtrace(); throw (Backtrace ("run", msg, get_context(), bt[..sizeof (bt) - 2]));
49897a2000-02-13Martin Stjernholm }
5ed0132000-02-13Martin Stjernholm void parse_error (string msg, mixed... args)
8cb24d2000-02-13Martin Stjernholm //! Throws an RXML parse error with a dump of the parser stack in the //! current context. This is intended to be used for programming //! errors in the RXML code, such as lookups in nonexisting scopes and //! invalid arguments to a tag.
49897a2000-02-13Martin Stjernholm {
8cb24d2000-02-13Martin Stjernholm  if (sizeof (args)) msg = sprintf (msg, @args);
51f88b2000-06-23Martin Stjernholm  array bt = backtrace(); throw (Backtrace ("parse", msg, get_context(), bt[..sizeof (bt) - 2]));
49897a2000-02-13Martin Stjernholm }
8cb24d2000-02-13Martin Stjernholm void fatal_error (string msg, mixed... args) //! Throws a Pike error that isn't catched and handled anywhere. It's //! just like the common error() function, but includes the RXML frame //! backtrace.
49897a2000-02-13Martin Stjernholm {
8cb24d2000-02-13Martin Stjernholm  if (sizeof (args)) msg = sprintf (msg, @args); array bt = backtrace(); throw_fatal (({msg, bt[..sizeof (bt) - 2]})); } void throw_fatal (mixed err) //! Mainly used internally to throw an error that includes the RXML //! frame backtrace. { if (arrayp (err) && sizeof (err) == 2 || objectp (err) && !err->is_RXML_Backtrace && err->is_generic_error) { string msg; if (catch (msg = err[0])) throw (err); if (stringp (msg) && !has_value (msg, "\nRXML frame backtrace:\n")) {
c64acf2000-02-17Martin Stjernholm  string descr = Backtrace (0, 0)->describe_rxml_backtrace (1);
5ed0132000-02-13Martin Stjernholm  if (sizeof (descr)) { if (sizeof (msg) && msg[-1] != '\n') msg += "\n"; msg += "RXML frame backtrace:\n" + descr; catch (err[0] = msg); }
8cb24d2000-02-13Martin Stjernholm  } } throw (err);
49897a2000-02-13Martin Stjernholm }
51f88b2000-06-23Martin Stjernholm Frame make_tag (string name, mapping(string:mixed) args, void|mixed content,
2e0a6d2000-07-06Martin Stjernholm  void|Tag overridden_by)
51f88b2000-06-23Martin Stjernholm //! Returns a frame for the specified tag, or 0 if no such tag exists. //! The tag definition is looked up in the current context and tag //! set. args and content are not parsed or evaluated. If //! overridden_by is given, the returned frame will come from the tag
2e0a6d2000-07-06Martin Stjernholm //! that overridden_by overrides, if there is any (name is not used in //! that case).
49897a2000-02-13Martin Stjernholm { TagSet tag_set = get_context()->tag_set;
2e0a6d2000-07-06Martin Stjernholm  Tag tag = overridden_by ? tag_set->get_overridden_tag (overridden_by) :
51f88b2000-06-23Martin Stjernholm  tag_set->get_tag (name);
2e0a6d2000-07-06Martin Stjernholm  return tag && tag (args, content);
49897a2000-02-13Martin Stjernholm }
51f88b2000-06-23Martin Stjernholm Frame make_unparsed_tag (string name, mapping(string:string) args, void|string content,
2e0a6d2000-07-06Martin Stjernholm  void|Tag overridden_by)
51f88b2000-06-23Martin Stjernholm //! Returns a frame for the specified tag, or 0 if no such tag exists. //! The tag definition is looked up in the current context and tag //! set. args and content are given unparsed in this variant; they're //! parsed when the frame is about to be evaluated. If overridden_by //! is given, the returned frame will come from the tag that
2e0a6d2000-07-06Martin Stjernholm //! overridden_by overrides, if there is any (name is not used in that //! case).
49897a2000-02-13Martin Stjernholm { TagSet tag_set = get_context()->tag_set;
2e0a6d2000-07-06Martin Stjernholm  Tag tag = overridden_by ? tag_set->get_overridden_tag (overridden_by) :
51f88b2000-06-23Martin Stjernholm  tag_set->get_tag (name); if (!tag) return 0;
49897a2000-02-13Martin Stjernholm  Frame frame = tag (args, content); frame->flags |= FLAG_UNPARSED; return frame; } class parse_frame /* (Type type, string to_parse) */ //! Returns a frame that, when evaluated, parses the given string //! according to the type (which typically has a parser set). { inherit Frame; constant flags = FLAG_UNPARSED; mapping(string:mixed) args = ([]); void create (Type type, string to_parse) { content_type = type, result_type = type (PNone); content = to_parse; } string _sprintf() {return sprintf ("parse_frame(%O)", content_type);} }
ed81751999-12-11Martin Stjernholm //! Parsers. class Parser //! Interface class for a syntax parser that scans, parses and //! evaluates an input stream. Access to a parser object is assumed to //! be done in a thread safe way except where noted. { constant is_RXML_Parser = 1;
56532d1999-12-19Martin Stjernholm  constant thrown_at_unwind = 1;
ed81751999-12-11Martin Stjernholm  //! Services.
db04172000-01-14Martin Stjernholm  int error_count; //! Number of RXML errors that occurred during evaluation. If this //! is nonzero, the value from eval() shouldn't be trusted.
ed81751999-12-11Martin Stjernholm  function(Parser:void) data_callback; //! A function to be called when data is likely to be available from //! eval(). It's always called when the source stream closes. //! write() and write_end() are the functions to use from outside //! the parser system, not feed() or finish(). int write (string in) //! Writes some source data to the parser. Returns nonzero if there //! might be data available in eval(). { int res; ENTER_CONTEXT (context);
80954c2000-03-03Martin Stjernholm  if (mixed err = catch {
56532d1999-12-19Martin Stjernholm  if (context && context->unwind_state && context->unwind_state->top) {
c6245b1999-12-31Martin Stjernholm #ifdef MODULE_DEBUG if (context->unwind_state->top != this_object())
8cb24d2000-02-13Martin Stjernholm  fatal_error ("The context got an unwound state from another parser. " "Can't rewind.\n");
c6245b1999-12-31Martin Stjernholm #endif
56532d1999-12-19Martin Stjernholm  m_delete (context->unwind_state, "top"); if (!sizeof (context->unwind_state)) context->unwind_state = 0; }
b436892000-01-19Martin Stjernholm  if (feed (in)) res = 1; // Might unwind.
ed81751999-12-11Martin Stjernholm  if (res && data_callback) data_callback (this_object());
80954c2000-03-03Martin Stjernholm  })
56532d1999-12-19Martin Stjernholm  if (objectp (err) && ([object] err)->thrown_at_unwind) {
c6245b1999-12-31Martin Stjernholm #ifdef DEBUG
80954c2000-03-03Martin Stjernholm  if (err != this_object()) { LEAVE_CONTEXT();
8cb24d2000-02-13Martin Stjernholm  fatal_error ("Internal error: Unexpected unwind object catched.\n");
80954c2000-03-03Martin Stjernholm  }
c6245b1999-12-31Martin Stjernholm #endif
56532d1999-12-19Martin Stjernholm  if (!context->unwind_state) context->unwind_state = ([]); context->unwind_state->top = err; }
80954c2000-03-03Martin Stjernholm  else { LEAVE_CONTEXT(); throw_fatal (err); } LEAVE_CONTEXT();
ed81751999-12-11Martin Stjernholm  return res; } void write_end (void|string in) //! Closes the source data stream, optionally with a last bit of //! data. { int res; ENTER_CONTEXT (context);
80954c2000-03-03Martin Stjernholm  if (mixed err = catch {
56532d1999-12-19Martin Stjernholm  if (context && context->unwind_state && context->unwind_state->top) {
c6245b1999-12-31Martin Stjernholm #ifdef MODULE_DEBUG if (context->unwind_state->top != this_object())
8cb24d2000-02-13Martin Stjernholm  fatal_error ("The context got an unwound state from another parser. " "Can't rewind.\n");
c6245b1999-12-31Martin Stjernholm #endif
56532d1999-12-19Martin Stjernholm  m_delete (context->unwind_state, "top"); if (!sizeof (context->unwind_state)) context->unwind_state = 0; }
b436892000-01-19Martin Stjernholm  finish (in); // Might unwind.
ed81751999-12-11Martin Stjernholm  if (data_callback) data_callback (this_object());
80954c2000-03-03Martin Stjernholm  })
56532d1999-12-19Martin Stjernholm  if (objectp (err) && ([object] err)->thrown_at_unwind) {
c6245b1999-12-31Martin Stjernholm #ifdef DEBUG
80954c2000-03-03Martin Stjernholm  if (err != this_object()) { LEAVE_CONTEXT();
8cb24d2000-02-13Martin Stjernholm  fatal_error ("Internal error: Unexpected unwind object catched.\n");
80954c2000-03-03Martin Stjernholm  }
c6245b1999-12-31Martin Stjernholm #endif
56532d1999-12-19Martin Stjernholm  if (!context->unwind_state) context->unwind_state = ([]); context->unwind_state->top = err; }
80954c2000-03-03Martin Stjernholm  else { LEAVE_CONTEXT(); throw_fatal (err); } LEAVE_CONTEXT();
01e43b2000-01-14Martin Stjernholm  }
1c73f62000-03-04Martin Stjernholm  array handle_var (string varref, Type surrounding_type)
01e43b2000-01-14Martin Stjernholm  // Parses and evaluates a possible variable reference, with the // appropriate error handling. { // We're always evaluating here, so context is always set.
0d37f22000-04-15Martin Nilsson  if(varref[0]==':') return ({ "&"+varref[1..]+";" }); array(string) split = Array.map( replace(varref, "..", ";") / ".", lambda(string in) { return replace(in, ";", "."); });
01e43b2000-01-14Martin Stjernholm  if (sizeof (split) == 2) if (mixed err = catch {
8778dd2000-02-05Martin Stjernholm  sscanf (split[1], "%[^:]:%s", split[1], string encoding);
db04172000-01-14Martin Stjernholm  context->current_var = varref;
01e43b2000-01-14Martin Stjernholm  mixed val;
710b482000-02-07Martin Stjernholm  if (zero_type (val = context->get_var ( // May throw.
1c73f62000-03-04Martin Stjernholm  split[1], split[0], encoding ? t_text : surrounding_type))) {
db04172000-01-14Martin Stjernholm  context->current_var = 0;
37e5462000-08-05Martin Nilsson  if(split[1]!="scopename") return ({}); val = context->frame->scope_name;
db04172000-01-14Martin Stjernholm  } context->current_var = 0;
6c902e2000-03-17Martin Stjernholm  return encoding ? ({Roxen->roxen_encode (val, encoding)}) : ({val});
01e43b2000-01-14Martin Stjernholm  }) {
db04172000-01-14Martin Stjernholm  context->current_var = 0;
01e43b2000-01-14Martin Stjernholm  context->handle_exception (err, this_object()); // May throw. return ({}); }
6efe862000-05-03Martin Stjernholm  if (!surrounding_type->free_text) parse_error ("Unknown variable reference &%s; not allowed in this context.\n", varref); return 0;
ed81751999-12-11Martin Stjernholm  } //! Interface. Context context; //! The context to do evaluation in. It's assumed to never be //! modified asynchronously during the time the parser is working on //! an input stream. Type type; //! The expected result type of the current stream. (The parser //! should not do any type checking on this.) int compile; //! Must be set to nonzero before a stream is fed which should be //! compiled to p-code.
46c68f2000-08-12Martin Stjernholm  //!int unwind_safe;
56532d1999-12-19Martin Stjernholm  //! If nonzero, the parser supports unwinding with throw()/catch(). //! Whenever an exception is thrown from some evaluation function, //! it should be able to call that function again with identical //! arguments the next time it continues.
ed81751999-12-11Martin Stjernholm  mixed feed (string in); //! Feeds some source data to the parse stream. The parser may do //! scanning and parsing before returning. If context is set, it may //! also do evaluation in that context. Returns nonzero if there //! could be new data to get from eval(). void finish (void|string in); //! Like feed(), but also finishes the parse stream. A last bit of //! data may be given. It should work to call this on an already //! finished stream if no argument is given to it.
8cb24d2000-02-13Martin Stjernholm  optional int report_error (string msg);
01e43b2000-01-14Martin Stjernholm  //! Used to report errors to the end user through the output. This
8cb24d2000-02-13Martin Stjernholm  //! is only called when type->free_text is nonzero. msg should be //! stored in the output queue to be returned by eval(). If the //! context is bad for an error message, do nothing and return zero, //! and return nonzero if a message was written.
01e43b2000-01-14Martin Stjernholm 
c6245b1999-12-31Martin Stjernholm  optional mixed read();
ed81751999-12-11Martin Stjernholm  //! Define to allow streaming operation. Returns the evaluated
46c68f2000-08-12Martin Stjernholm  //! result so far, but does not do any evaluation. Returns RXML.nil //! if there's no data (for sequential types the empty value is also
ed81751999-12-11Martin Stjernholm  //! ok).
56532d1999-12-19Martin Stjernholm  mixed eval();
ed81751999-12-11Martin Stjernholm  //! Evaluates the data fed so far and returns the result. The result //! returned by previous eval() calls should not be returned again
46c68f2000-08-12Martin Stjernholm  //! as (part of) this return value. Returns RXML.nil if there's no //! data (for sequential types the empty value is also ok).
ed81751999-12-11Martin Stjernholm 
c6245b1999-12-31Martin Stjernholm  optional PCode p_compile();
ed81751999-12-11Martin Stjernholm  //! Define this to return a p-code representation of the current //! stream, which always is finished.
c6245b1999-12-31Martin Stjernholm  optional void reset (Context ctx, Type type, mixed... args);
ed81751999-12-11Martin Stjernholm  //! Define to support reuse of a parser object. It'll be called //! instead of making a new object for a new stream. It keeps the
b2d01b2000-02-15Martin Stjernholm  //! static configuration, i.e. the type (and tag set when used in //! TagSetParser). Note that this function needs to deal with //! leftovers from add_runtime_tag() for TagSetParser objects.
ed81751999-12-11Martin Stjernholm 
c6245b1999-12-31Martin Stjernholm  optional Parser clone (Context ctx, Type type, mixed... args);
ed81751999-12-11Martin Stjernholm  //! Define to create new parser objects by cloning instead of //! creating from scratch. It returns a new instance of this parser
b2d01b2000-02-15Martin Stjernholm  //! with the same static configuration, i.e. the type (and tag set //! when used in TagSetParser).
ed81751999-12-11Martin Stjernholm 
2bd21a2000-01-05Martin Stjernholm  static void create (Context ctx, Type _type, mixed... args)
ed81751999-12-11Martin Stjernholm  { context = ctx; type = _type;
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG __object_marker->create (this_object()); #endif
ed81751999-12-11Martin Stjernholm  }
51f88b2000-06-23Martin Stjernholm  string current_input() {return 0;} //! Should return the representation in the input stream for the //! current tag or entity being parsed, or 0 if it isn't known.
ed81751999-12-11Martin Stjernholm  // Internals. Parser _next_free; // Used to link together unused parser objects for reuse.
c6245b1999-12-31Martin Stjernholm  Parser _parent; // The parent parser if this one is nested.
2bd21a2000-01-05Martin Stjernholm 
01e43b2000-01-14Martin Stjernholm  Stdio.File _source_file; mapping _defines; // These two are compatibility kludges for use with parse_rxml().
f02d002000-03-18Martin Stjernholm  MARK_OBJECT_ONLY;
ec027c2000-03-16Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  string _sprintf() { return sprintf ("RXML.Parser(%O,%O)%s", context, type, OBJ_COUNT); }
ed81751999-12-11Martin Stjernholm } class TagSetParser //! Interface class for parsers that evaluates using the tag set. It //! provides the evaluation and compilation functionality. The parser
c6245b1999-12-31Martin Stjernholm //! should call Tag._handle_tag() from feed() and finish() for every
24f9e82000-08-05Martin Stjernholm //! encountered element tag and Tag._handle_pi_tag() for every PI tag. //! Parser.handle_var() should be called for encountered variable
c6245b1999-12-31Martin Stjernholm //! references. It must be able to continue cleanly after throw() from
24f9e82000-08-05Martin Stjernholm //! Tag._handle_tag() and Tag._handle_pi_tag().
ed81751999-12-11Martin Stjernholm { inherit Parser;
ffa6932000-02-20Martin Stjernholm  constant is_RXML_TagSetParser = 1;
1b2b752000-01-07Martin Stjernholm  constant tag_set_eval = 1;
2bd21a2000-01-05Martin Stjernholm  // Services.
b436892000-01-19Martin Stjernholm  mixed eval() {return read();}
ed81751999-12-11Martin Stjernholm  // Interface.
1b2b752000-01-07Martin Stjernholm  TagSet tag_set;
ed81751999-12-11Martin Stjernholm  //! The tag set used for parsing.
f02d002000-03-18Martin Stjernholm  optional void reset (Context ctx, Type _type, TagSet tag_set, mixed... args); optional Parser clone (Context ctx, Type _type, TagSet tag_set, mixed... args); static void create (Context ctx, Type _type, TagSet _tag_set, mixed... args)
ed81751999-12-11Martin Stjernholm  {
f02d002000-03-18Martin Stjernholm  //::create (ctx, _type); context = ctx; type = _type;
1b2b752000-01-07Martin Stjernholm  tag_set = _tag_set;
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG __object_marker->create (this_object()); #endif
ed81751999-12-11Martin Stjernholm  } //! In addition to the type, the tag set is part of the static //! configuration.
2bd21a2000-01-05Martin Stjernholm  mixed read();
3187d82000-01-28Martin Stjernholm  //! No longer optional in this class. Since the evaluation is done //! in Tag._handle_tag() or similar, this always does the same as //! eval().
2bd21a2000-01-05Martin Stjernholm 
b2d01b2000-02-15Martin Stjernholm  optional void add_runtime_tag (Tag tag);
c6245b1999-12-31Martin Stjernholm  //! Adds a tag that will exist from this point forward in the
b2d01b2000-02-15Martin Stjernholm  //! current parser instance only. This may only be left undefined if //! the parser doesn't parse tags at all.
ed81751999-12-11Martin Stjernholm 
24f9e82000-08-05Martin Stjernholm  optional void remove_runtime_tag (string|Tag tag, void|int proc_instr); //! If tag is a Tag object, it's removed from the set of runtime //! tags that's been added by add_runtime_tag(). If tag is a string, //! the tag with that name is removed. In this case, if proc_instr //! is nonzero the set of runtime PI tags is searched, else the set //! of normal element runtime tags. This may only be left undefined //! if the parser doesn't parse tags at all.
2bd21a2000-01-05Martin Stjernholm 
9502852000-02-15Martin Stjernholm  // Internals. int _local_tag_set;
f02d002000-03-18Martin Stjernholm  string _sprintf() { return sprintf ("RXML.TagSetParser(%O,%O,%O)%s", context, type, tag_set, OBJ_COUNT); }
c6245b1999-12-31Martin Stjernholm }
ed81751999-12-11Martin Stjernholm  class PNone //! The identity parser. It only returns its input. { inherit Parser; string data = ""; int evalpos = 0; int feed (string in) { data += in; return 1; } void finish (void|string in) { if (in) data += in; } string eval() { string res = data[evalpos..]; evalpos = sizeof (data); return res; } string byte_compile() { return data; } string byte_interpret (string byte_code, Context ctx) { return byte_code; } void reset (Context ctx) { context = ctx; data = ""; evalpos = 0; }
2bd21a2000-01-05Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.PNone" + OBJ_COUNT;}
ed81751999-12-11Martin Stjernholm } mixed simple_parse (string in, void|program parser) //! A convenience function to parse a string with no type info, no tag //! set, and no variable references. The parser defaults to PExpr. { // FIXME: Recycle contexts?
1b2b752000-01-07Martin Stjernholm  return t_any (parser || PExpr)->eval (in, Context (empty_tag_set));
ed81751999-12-11Martin Stjernholm } //! Types. class Type //! A static type definition. It does type checking and specifies some //! properties of the type. It may also contain a Parser program that //! will be used to read text and evaluate values of this type. Note //! that the parser is not relevant for type checking. { constant is_RXML_Type = 1; //! Interface. //!string name; //! Unique type identifier. Required and considered constant. Type //! hierarchies are currently implemented with glob patterns, e.g.
46c68f2000-08-12Martin Stjernholm  //! "image/png" is a subtype of "image/*". However, this syntax will //! be developed further, so for now use only characters [a-zA-Z/] //! to write MIME-like types and use only * for globbing.
ed81751999-12-11Martin Stjernholm 
46c68f2000-08-12Martin Stjernholm  //!int sequential;
ed81751999-12-11Martin Stjernholm  //! Nonzero if data of this type is sequential, defined as: //! o One or more data items can be concatenated with `+. //! o (Sane) parsers are homomorphic on the type, i.e. //! eval ("da") + eval ("ta") == eval ("da" + "ta") //! and //! eval ("data") + eval ("") == eval ("data")
c6245b1999-12-31Martin Stjernholm  //! provided the data is only split between (sensibly defined) //! atomic elements.
ed81751999-12-11Martin Stjernholm 
e213f01999-12-13Martin Stjernholm  //!mixed empty_value;
383dd22000-02-16Martin Stjernholm  //! The empty value, i.e. what eval ("") would produce.
ed81751999-12-11Martin Stjernholm 
46c68f2000-08-12Martin Stjernholm  //!int free_text;
ed81751999-12-11Martin Stjernholm  //! Nonzero if the type keeps the free text between parsed tokens,
8cb24d2000-02-13Martin Stjernholm  //! e.g. the plain text between tags in XML. The type must be
ed81751999-12-11Martin Stjernholm  //! sequential and use strings. void type_check (mixed val);
01e43b2000-01-14Martin Stjernholm  //! Checks whether the given value is a valid one of this type. Type
5ed0132000-02-13Martin Stjernholm  //! errors are thrown with RXML.parse_error().
ed81751999-12-11Martin Stjernholm 
46c68f2000-08-12Martin Stjernholm  //!string encoding_type; //! A type name identifying the encoding in this type, if //! applicable. Conversion between two types with identical
23a0882000-08-12Martin Stjernholm  //! encoding_type is always a nop, so the call to encode() may be
46c68f2000-08-12Martin Stjernholm  //! skipped.
23a0882000-08-12Martin Stjernholm  //! //! Types that have no encoding_type is taken to represent values in //! internal "raw" form, e.g. for strings this means that they are //! literals with no encoding scheme, so that every character //! represents only itself.
590b3c2000-02-05Martin Stjernholm 
23a0882000-08-12Martin Stjernholm  mixed encode (mixed val, void|Type from);
590b3c2000-02-05Martin Stjernholm  //! Converts the given value to this type. If the from type is
23a0882000-08-12Martin Stjernholm  //! given, it's the type of the value. If it's not given, the value //! is assumed to be in raw form (see encoding_type) If the type //! can't be converted, an RXML parse error should be thrown. mixed decode (mixed val); //! Converts the value, which is of this type, to the raw form (see //! encoding_type). If the type can't be converted, an RXML parse //! error should be thrown. That might happen if the value contains //! markup or similar that can't be represented in raw form.
8778dd2000-02-05Martin Stjernholm  //!
23a0882000-08-12Martin Stjernholm  //! E.g. when converting some XML text, the function should return a //! literal string only if the text doesn't contain tags, otherwise //! it should throw an error (since there currently exists no //! internal representation of an XML node tree). It should never //! both decode e.g. "&lt;" to "<" and just leave literal "<" in the //! string. It should also not parse the value with some evaluating //! parser (see get_parser) since the value should not be evaluated, //! it should only change representation.
8778dd2000-02-05Martin Stjernholm 
ed81751999-12-11Martin Stjernholm  Type clone() //! Returns a copy of the type. {
94edc22000-03-23Henrik Grubbström (Grubba)  Type newtype = object_program ((object(this_program)) this_object())();
ed81751999-12-11Martin Stjernholm  newtype->_parser_prog = _parser_prog;
c757c42000-01-08Martin Stjernholm  newtype->_parser_args = _parser_args;
ed81751999-12-11Martin Stjernholm  newtype->_t_obj_cache = _t_obj_cache; return newtype; }
51f88b2000-06-23Martin Stjernholm  string format_tag (string|Tag tag, void|mapping(string:string) args, void|string content, void|int flags) //! Returns a formatted tag according to the type. tag is either a //! tag object or the name of the tag. Throws an error if this type //! cannot format tags. { parse_error ("Cannot format tags with type %s.\n", this_object()->name); } string format_entity (string entity) //! Returns a formatted entity according to the type. Throws an //! error if this type cannot format entities. { parse_error ("Cannot format entities with type %s.\n", this_object()->name); }
ed81751999-12-11Martin Stjernholm  //! Services. int `== (mixed other) //! {
56532d1999-12-19Martin Stjernholm  return objectp (other) && ([object] other)->is_RXML_Type && ([object(Type)] other)->name == this_object()->name;
ed81751999-12-11Martin Stjernholm  } int subtype_of (Type other) //! {
56532d1999-12-19Martin Stjernholm  return glob ([string] other->name, [string] this_object()->name);
ed81751999-12-11Martin Stjernholm  }
2bd21a2000-01-05Martin Stjernholm  Type `() (program/*(Parser)HMM*/ newparser, mixed... parser_args)
ed81751999-12-11Martin Stjernholm  //! Returns a type identical to this one, but which has the given //! parser. parser_args is passed as extra arguments to the //! create()/reset()/clone() functions. { Type newtype; if (sizeof (parser_args)) { // Can't cache this. newtype = clone();
c757c42000-01-08Martin Stjernholm  newtype->_parser_prog = newparser;
ed81751999-12-11Martin Stjernholm  newtype->_parser_args = parser_args;
f02d002000-03-18Martin Stjernholm  if (newparser->tag_set_eval) newtype->_p_cache = set_weak_flag (([]), 1);
ed81751999-12-11Martin Stjernholm  } else { if (!_t_obj_cache) _t_obj_cache = ([]); if (!(newtype = _t_obj_cache[newparser])) if (newparser == _parser_prog)
56532d1999-12-19Martin Stjernholm  _t_obj_cache[newparser] = newtype = this_object();
ed81751999-12-11Martin Stjernholm  else { _t_obj_cache[newparser] = newtype = clone(); newtype->_parser_prog = newparser;
f02d002000-03-18Martin Stjernholm  if (newparser->tag_set_eval) newtype->_p_cache = set_weak_flag (([]), 1);
ed81751999-12-11Martin Stjernholm  } } return newtype; }
0ebc9d2000-02-15Martin Stjernholm  inline Parser get_parser (Context ctx, void|TagSet tag_set, void|Parser|PCode parent)
ed81751999-12-11Martin Stjernholm  //! Returns a parser instance initialized with the given context. { Parser p; if (_p_cache) { // It's a tag set parser.
0ebc9d2000-02-15Martin Stjernholm  TagSet tset = tag_set || ctx->tag_set;
ffa6932000-02-20Martin Stjernholm  if (parent && parent->is_RXML_TagSetParser && tset == parent->tag_set && sizeof (ctx->runtime_tags) &&
0ebc9d2000-02-15Martin Stjernholm  parent->clone && parent->type == this_object()) { // There are runtime tags. Try to clone the parent parser if // all conditions are met. p = parent->clone (ctx, this_object(), tset, @_parser_args); p->_parent = parent; return p; }
ed81751999-12-11Martin Stjernholm  // vvv Using interpreter lock from here.
0ebc9d2000-02-15Martin Stjernholm  PCacheObj pco = _p_cache[tset];
1b2b752000-01-07Martin Stjernholm  if (pco && pco->tag_set_gen == tset->generation) {
ed81751999-12-11Martin Stjernholm  if ((p = pco->free_parser)) { pco->free_parser = p->_next_free; // ^^^ Using interpreter lock to here. p->data_callback = p->compile = 0;
2bd21a2000-01-05Martin Stjernholm  p->reset (ctx, this_object(), tset, @_parser_args);
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif
ed81751999-12-11Martin Stjernholm  }
0ebc9d2000-02-15Martin Stjernholm 
ed81751999-12-11Martin Stjernholm  else // ^^^ Using interpreter lock to here. if (pco->clone_parser)
2bd21a2000-01-05Martin Stjernholm  p = pco->clone_parser->clone (ctx, this_object(), tset, @_parser_args);
ec027c2000-03-16Martin Stjernholm  else if ((p = _parser_prog (ctx, this_object(), tset, @_parser_args))->clone) {
ed81751999-12-11Martin Stjernholm  // pco->clone_parser might already be initialized here due // to race, but that doesn't matter.
ec027c2000-03-16Martin Stjernholm  p->context = 0; // Don't leave the context in the clone master.
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif
2bd21a2000-01-05Martin Stjernholm  p = (pco->clone_parser = p)->clone (ctx, this_object(), tset, @_parser_args);
ec027c2000-03-16Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm  }
0ebc9d2000-02-15Martin Stjernholm 
ed81751999-12-11Martin Stjernholm  else { // ^^^ Using interpreter lock to here. pco = PCacheObj();
1b2b752000-01-07Martin Stjernholm  pco->tag_set_gen = tset->generation;
ed81751999-12-11Martin Stjernholm  _p_cache[tset] = pco; // Might replace an object due to race, but that's ok.
ec027c2000-03-16Martin Stjernholm  if ((p = _parser_prog (ctx, this_object(), tset, @_parser_args))->clone) {
ed81751999-12-11Martin Stjernholm  // pco->clone_parser might already be initialized here due // to race, but that doesn't matter.
ec027c2000-03-16Martin Stjernholm  p->context = 0; // Don't leave the context in the clone master.
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif
2bd21a2000-01-05Martin Stjernholm  p = (pco->clone_parser = p)->clone (ctx, this_object(), tset, @_parser_args);
ec027c2000-03-16Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm  }
0ebc9d2000-02-15Martin Stjernholm 
b2d01b2000-02-15Martin Stjernholm  if (ctx->tag_set == tset && p->add_runtime_tag && sizeof (ctx->runtime_tags))
87fb7e2000-03-25Martin Stjernholm  foreach (values (ctx->runtime_tags), Tag tag)
0ebc9d2000-02-15Martin Stjernholm  p->add_runtime_tag (tag);
ed81751999-12-11Martin Stjernholm  }
0ebc9d2000-02-15Martin Stjernholm 
ed81751999-12-11Martin Stjernholm  else { if ((p = free_parser)) { // Relying on interpreter lock here. free_parser = p->_next_free; p->data_callback = p->compile = 0; p->reset (ctx, this_object(), @_parser_args);
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif
ed81751999-12-11Martin Stjernholm  }
0ebc9d2000-02-15Martin Stjernholm 
ed81751999-12-11Martin Stjernholm  else if (clone_parser) // Relying on interpreter lock here.
c6245b1999-12-31Martin Stjernholm  p = clone_parser->clone (ctx, this_object(), @_parser_args);
0ebc9d2000-02-15Martin Stjernholm 
ec027c2000-03-16Martin Stjernholm  else if ((p = _parser_prog (ctx, this_object(), @_parser_args))->clone) {
ed81751999-12-11Martin Stjernholm  // clone_parser might already be initialized here due to race, // but that doesn't matter.
ec027c2000-03-16Martin Stjernholm  p->context = 0; // Don't leave the context in the clone master.
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif
c6245b1999-12-31Martin Stjernholm  p = (clone_parser = p)->clone (ctx, this_object(), @_parser_args);
ec027c2000-03-16Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm  }
0ebc9d2000-02-15Martin Stjernholm  p->_parent = parent;
ed81751999-12-11Martin Stjernholm  return p; }
01e43b2000-01-14Martin Stjernholm  mixed eval (string in, void|Context ctx, void|TagSet tag_set, void|Parser|PCode parent, void|int dont_switch_ctx)
51f88b2000-06-23Martin Stjernholm  //! Parses and evaluates the value in the given string. If a context //! isn't given, the current one is used. The current context and //! ctx are assumed to be the same if dont_switch_ctx is nonzero.
ed81751999-12-11Martin Stjernholm  { mixed res; if (!ctx) ctx = get_context(); if (_parser_prog == PNone) res = in; else {
0ebc9d2000-02-15Martin Stjernholm  Parser p = get_parser (ctx, tag_set, parent);
01e43b2000-01-14Martin Stjernholm  p->_parent = parent;
ed81751999-12-11Martin Stjernholm  if (dont_switch_ctx) p->finish (in); // Optimize the job in p->write_end(). else p->write_end (in); res = p->eval();
ec027c2000-03-16Martin Stjernholm  if (p->reset) { p->context = p->_parent = 0;
f02d002000-03-18Martin Stjernholm #ifdef RXML_OBJ_DEBUG p->__object_marker->create (p); #endif
ed81751999-12-11Martin Stjernholm  if (_p_cache) {
9477392000-03-20Martin Stjernholm  if (PCacheObj pco = _p_cache[tag_set || ctx->tag_set]) { // Relying on interpreter lock here. p->_next_free = pco->free_parser; pco->free_parser = p; }
ed81751999-12-11Martin Stjernholm  } else { // Relying on interpreter lock in this block. p->_next_free = free_parser; free_parser = p; }
ec027c2000-03-16Martin Stjernholm  }
ed81751999-12-11Martin Stjernholm  } if (ctx->type_check) type_check (res); return res; } // Internals. program/*(Parser)HMM*/ _parser_prog = PNone; // The parser to use. Should never be changed in a type object.
c757c42000-01-08Martin Stjernholm  /*private*/ array(mixed) _parser_args = ({});
ed81751999-12-11Martin Stjernholm  /*private*/ mapping(program:Type) _t_obj_cache; // To avoid creating new type objects all the time in `(). // Cache used for parsers that doesn't depend on the tag set. private Parser clone_parser; // Used with Parser.clone(). private Parser free_parser; // The list of objects to reuse with Parser.reset(). // Cache used for parsers that depend on the tag set. /*private*/ mapping(TagSet:PCacheObj) _p_cache;
2bd21a2000-01-05Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  MARK_OBJECT_ONLY;
ec027c2000-03-16Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.Type" + OBJ_COUNT;}
ec027c2000-03-16Martin Stjernholm } static class PCacheObj { int tag_set_gen; Parser clone_parser; Parser free_parser;
ed81751999-12-11Martin Stjernholm }
23a0882000-08-12Martin Stjernholm TAny t_any = TAny();
46c68f2000-08-12Martin Stjernholm //! A completely unspecified nonsequential type. Every type is a //! subtype of this one.
23a0882000-08-12Martin Stjernholm  static class TAny
01e43b2000-01-14Martin Stjernholm { inherit Type; constant name = "*";
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.t_any" + OBJ_COUNT;}
01e43b2000-01-14Martin Stjernholm }
23a0882000-08-12Martin Stjernholm TNil t_nil = TNil();
46c68f2000-08-12Martin Stjernholm //! A sequential type accepting only the value nil. This type is by //! definition a subtype of every sequential type.
23a0882000-08-12Martin Stjernholm  static class TNil
49897a2000-02-13Martin Stjernholm { inherit Type;
46c68f2000-08-12Martin Stjernholm  constant name = "nil";
49897a2000-02-13Martin Stjernholm  constant sequential = 1;
46c68f2000-08-12Martin Stjernholm  Nil empty_value = nil;
23a0882000-08-12Martin Stjernholm 
49897a2000-02-13Martin Stjernholm  void type_check (mixed val)
23a0882000-08-12Martin Stjernholm  { if (val != nil) parse_error ("A non-nil value is not accepted.\n"); } mixed encode (mixed val) { #ifdef MODULE_DEBUG type_check (val); #endif return nil; } mixed decode (mixed val) { #ifdef MODULE_DEBUG type_check (val); #endif return nil; }
46c68f2000-08-12Martin Stjernholm  int subtype_of (Type other) {return other->sequential || other == t_any;}
23a0882000-08-12Martin Stjernholm 
46c68f2000-08-12Martin Stjernholm  string _sprintf() {return "RXML.t_nil" + OBJ_COUNT;}
49897a2000-02-13Martin Stjernholm }
23a0882000-08-12Martin Stjernholm TSame t_same = TSame();
590b3c2000-02-05Martin Stjernholm //! A magic type used in Tag.content_type.
23a0882000-08-12Martin Stjernholm  static class TSame
590b3c2000-02-05Martin Stjernholm { inherit Type; constant name = "same";
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.t_same" + OBJ_COUNT;}
590b3c2000-02-05Martin Stjernholm }
23a0882000-08-12Martin Stjernholm TText t_text = TText();
ed81751999-12-11Martin Stjernholm //! The standard type for generic document text.
23a0882000-08-12Martin Stjernholm  static class TText
ed81751999-12-11Martin Stjernholm { inherit Type; constant name = "text/*"; constant sequential = 1; constant empty_value = ""; constant free_text = 1;
46c68f2000-08-12Martin Stjernholm  constant encoding_type = "none";
8778dd2000-02-05Martin Stjernholm 
23a0882000-08-12Martin Stjernholm  void type_check (mixed val)
8778dd2000-02-05Martin Stjernholm  {
23a0882000-08-12Martin Stjernholm  if (!stringp (val)) parse_error ("The text value is not a string.\n"); } string encode (mixed val, void|Type from) { if (mixed err = catch {val = (string) val;}) parse_error ("Cannot convert value to text: " + describe_error (err)); if (from && from->encoding_type != encoding_type) val = from->decode ([string] val); return [string] val; } string decode (mixed val) { #ifdef MODULE_DEBUG type_check (val); #endif return val;
8778dd2000-02-05Martin Stjernholm  }
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.t_text" + OBJ_COUNT;}
01e43b2000-01-14Martin Stjernholm }
ed81751999-12-11Martin Stjernholm 
23a0882000-08-12Martin Stjernholm THtml t_xml = TXml();
8778dd2000-02-05Martin Stjernholm //! The type for XML and similar markup.
23a0882000-08-12Martin Stjernholm  static class TXml
ed81751999-12-11Martin Stjernholm {
26ff092000-01-21Martin Stjernholm  inherit TText;
8778dd2000-02-05Martin Stjernholm  constant name = "text/xml";
46c68f2000-08-12Martin Stjernholm  constant encoding_type = "xml";
8778dd2000-02-05Martin Stjernholm 
23a0882000-08-12Martin Stjernholm  string encode (mixed val, void|Type from)
590b3c2000-02-05Martin Stjernholm  { if (mixed err = catch {val = (string) val;})
23a0882000-08-12Martin Stjernholm  parse_error ("Cannot convert value to text: " + describe_error (err)); if (!from) from = t_text; if (from->encoding_type != encoding_type)
46c68f2000-08-12Martin Stjernholm  return replace (
23a0882000-08-12Martin Stjernholm  from->decode ([string] val),
46c68f2000-08-12Martin Stjernholm  // FIXME: This ignores the invalid Unicode character blocks. ({"&", "<", ">", "\"", "\'", "\000", "\001", "\002", "\003", "\004", "\005", "\006", "\007", "\010", "\013", "\014", "\016", "\017", "\020", "\021", "\022", "\023", "\024", "\025", "\026", "\027", "\030", "\031", "\032", "\033", "\034", "\035", "\036", "\037", }), ({"&amp;", "&lt;", "&gt;", /*"&quot;"*/ "&#34;", /*"&apos;"*/ "&#39;", "&#0;", "&#1;", "&#2;", "&#3;", "&#4;", "&#5;", "&#6;", "&#7;", "&#8;", "&#11;", "&#12;", "&#14;", "&#15;", "&#16;", "&#17;", "&#18;", "&#19;", "&#20;", "&#21;", "&#22;", "&#23;", "&#24;", "&#25;", "&#26;", "&#27;", "&#28;", "&#29;", "&#30;", "&#31;", })); return [string] val;
590b3c2000-02-05Martin Stjernholm  }
23a0882000-08-12Martin Stjernholm  string decode (mixed val) { #ifdef MODULE_DEBUG type_check (val); #endif return charref_decode_parser->clone()->finish (val)->read(); }
51f88b2000-06-23Martin Stjernholm  string format_tag (string|Tag tag, void|mapping(string:string) args, void|string content, void|int flags)
24f9e82000-08-05Martin Stjernholm  //! Returns a formatted XML tag. The flags argument contains a flag //! field compatible with Tag.flags etc; the flags FLAG_PROC_INSTR, //! FLAG_COMPAT_PARSE, FLAG_EMPTY_ELEMENT and FLAG_RAW_ARGS are //! heeded when formatting the tag. If tag is an object, its flags //! field is used instead of the flags argument.
51f88b2000-06-23Martin Stjernholm  { string tagname; if (objectp (tag)) tagname = tag->name, flags = tag->flags; else tagname = tag;
24f9e82000-08-05Martin Stjernholm  if (flags & FLAG_PROC_INSTR) return "<?" + tagname + " " + content + "?>";
51f88b2000-06-23Martin Stjernholm  string res = "<" + tagname;
24f9e82000-08-05Martin Stjernholm 
51f88b2000-06-23Martin Stjernholm  if (args)
9a38062000-08-04Martin Stjernholm  if (flags & FLAG_RAW_ARGS) foreach (indices (args), string arg) res += " " + arg + "=\"" + replace (args[arg], "\"", "\"'\"'\"") + "\""; else foreach (indices (args), string arg) res += " " + arg + "=" + Roxen->html_encode_tag_value (args[arg]);
24f9e82000-08-05Martin Stjernholm 
51f88b2000-06-23Martin Stjernholm  if (content) res += ">" + content + "</" + tag->name + ">"; else if (flags & FLAG_COMPAT_PARSE) if (flags & FLAG_EMPTY_ELEMENT) res += ">"; else res += "></" + tag->name + ">"; else res += " />";
24f9e82000-08-05Martin Stjernholm 
51f88b2000-06-23Martin Stjernholm  return res; } string format_entity (string entity) { return "&" + entity + ";"; }
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.t_xml" + OBJ_COUNT;}
8778dd2000-02-05Martin Stjernholm }
23a0882000-08-12Martin Stjernholm  THtml t_html = THtml(); //! (Currently) identical to t_xml, but tags it as "text/html".
8778dd2000-02-05Martin Stjernholm  static class THtml { inherit TXml;
01e43b2000-01-14Martin Stjernholm  constant name = "text/html";
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.t_html" + OBJ_COUNT;}
01e43b2000-01-14Martin Stjernholm }
ed81751999-12-11Martin Stjernholm  // P-code compilation and evaluation. class VarRef //! A helper for representing variable reference tokens. { constant is_RXML_VarRef = 1; string scope, var;
2bd21a2000-01-05Martin Stjernholm  static void create (string _scope, string _var) {scope = _scope, var = _var;}
af06d52000-01-12Martin Stjernholm  int valid (Context ctx) {return ctx->exist_scope (scope);} mixed get (Context ctx) {return ctx->get_var (var, scope);} mixed set (Context ctx, mixed val) {return ctx->set_var (var, val, scope);} void delete (Context ctx) {ctx->delete_var (var, scope);}
ed81751999-12-11Martin Stjernholm  string name() {return scope + "." + var;}
f02d002000-03-18Martin Stjernholm  MARK_OBJECT; string _sprintf() {return "RXML.VarRef(" + scope + "." + var + ")" + OBJ_COUNT;}
ed81751999-12-11Martin Stjernholm } class PCode //! Holds p-code and evaluates it. P-code is the intermediate form //! after parsing and before evaluation. { constant is_RXML_PCode = 1;
56532d1999-12-19Martin Stjernholm  constant thrown_at_unwind = 1;
ed81751999-12-11Martin Stjernholm  array p_code = ({});
db04172000-01-14Martin Stjernholm  int error_count; //! Number of RXML errors that occurred during evaluation. If this //! is nonzero, the value from eval() shouldn't be trusted.
ed81751999-12-11Martin Stjernholm  mixed eval (Context ctx) //! Evaluates the p-code in the given context. { // FIXME
23a0882000-08-12Martin Stjernholm  // Note: Remember to initialize Frame.content and Frame.result // when reusing frames.
ed81751999-12-11Martin Stjernholm  }
56532d1999-12-19Martin Stjernholm  function(Context:mixed) compile();
ed81751999-12-11Martin Stjernholm  //! Returns a compiled function for doing the evaluation. The //! function will receive a context to do the evaluation in.
2bd21a2000-01-05Martin Stjernholm 
01e43b2000-01-14Martin Stjernholm  // Internals. void report_error (string msg) { // FIXME } PCode|Parser _parent; // The parent evaluator if this one is nested.
26ff092000-01-21Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  MARK_OBJECT;
26ff092000-01-21Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.PCode" + OBJ_COUNT;}
ed81751999-12-11Martin Stjernholm } //! Some parser tools.
23a0882000-08-12Martin Stjernholm Nil nil = Nil(); //! An object representing the empty value. Works as initializer for //! sequences, since nil + anything == anything + nil == anything. It //! can cast itself to the empty value for the basic Pike types. It //! also evaluates to false in a boolean context, but it's not equal //! to 0.
46c68f2000-08-12Martin Stjernholm static class Nil
ed81751999-12-11Martin Stjernholm { mixed `+ (mixed... vals) {return sizeof (vals) ? predef::`+ (@vals) : this_object();} mixed ``+ (mixed val) {return val;} int `!() {return 1;}
46c68f2000-08-12Martin Stjernholm  string _sprintf() {return "RXML.nil";}
8e022f2000-05-26Martin Nilsson  mixed cast(string type) { switch(type) { case "int": return 0; case "float": return 0.0; case "string": return ""; case "array": return ({}); case "multiset": return (<>); case "mapping": return ([]); default:
46c68f2000-08-12Martin Stjernholm  error ("Cannot cast RXML.nil to "+type+".\n");
8e022f2000-05-26Martin Nilsson  } }
ed81751999-12-11Martin Stjernholm };
8e022f2000-05-26Martin Nilsson 
46c68f2000-08-12Martin Stjernholm Nil Void = nil; // Compatibility.
ed81751999-12-11Martin Stjernholm  class ScanStream //! A helper class for the input and scanner stage in a parser. It's a //! stream that takes unparsed strings and splits them into tokens //! which are queued. Intended to be inherited in a Parser class. { private Link head = Link(); // Last link is an empty eof marker. private Link tail = head; private int next_token = 0; private string end = ""; private int fin = 0; array scan (string in, int finished); //! The scanner function. It gets an unparsed string and should //! return an array of tokens. If the second argument is nonzero, //! there won't be any more data later. If the second argument is //! zero, the last item in the returned array is handled as unparsed //! data that will be passed back to the scanner later. Tokens may //! be of any type. Use VarRef objects for variables. void feed (string in) //! { #ifdef MODULE_DEBUG
8cb24d2000-02-13Martin Stjernholm  if (fin) fatal_error ("Cannot feed data to a finished stream.\n");
ed81751999-12-11Martin Stjernholm #endif array tokens = scan (end + in, 0); end = [string] tokens[-1]; if (sizeof (tokens) > 1) { tail->data = tokens[..sizeof (tokens) - 2]; tail = tail->next = Link(); } } void finish (void|string in) //! { if (in || !fin && sizeof (end)) { #ifdef MODULE_DEBUG
8cb24d2000-02-13Martin Stjernholm  if (in && fin) fatal_error ("Cannot feed data to a finished stream.\n");
ed81751999-12-11Martin Stjernholm #endif fin = 1; if (in) end += in; tail->data = scan (end, 1); tail = tail->next = Link(); } } void reset() //! { head = Link(); tail = head; next_token = 0; end = ""; fin = 0; } mixed read()
46c68f2000-08-12Martin Stjernholm  //! Returns the next token, or RXML.nil if there's no more data.
ed81751999-12-11Martin Stjernholm  { while (head->next) if (next_token >= sizeof (head->data)) { next_token = 0; head = head->next; } else return head->data[next_token++];
46c68f2000-08-12Martin Stjernholm  return nil;
ed81751999-12-11Martin Stjernholm  } void unread (mixed... put_back) //! Puts back tokens and variable references at the beginning of the //! stream so that the leftmost argument will be read first. { int i = sizeof (put_back); while (i) head->data[--next_token] = put_back[--i]; if (i) { Link l = Link(); l->next = head, head = l;
56532d1999-12-19Martin Stjernholm  l->data = allocate (next_token = max (i - 32, 0)) + put_back[..--i];
ed81751999-12-11Martin Stjernholm  } } array read_all() //! { array data; if (next_token) { data = head->data[next_token..]; head = head->next; next_token = 0; } else data = ({}); while (head->next) { data += head->data; head = head->next; } return data; } int finished() //! Returns nonzero if the write end is finished. { return fin; }
2bd21a2000-01-05Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  MARK_OBJECT;
ec027c2000-03-16Martin Stjernholm 
f02d002000-03-18Martin Stjernholm  string _sprintf() {return "RXML.ScanStream" + OBJ_COUNT;}
ec027c2000-03-16Martin Stjernholm } private class Link { array data; Link next;
ed81751999-12-11Martin Stjernholm }
f02d002000-03-18Martin Stjernholm // Caches and object tracking. static int tag_set_count = 0;
996df72000-03-18Martin Stjernholm mapping(int|string:TagSet) garb_local_tag_set_cache() { call_out (garb_local_tag_set_cache, 30*60); return local_tag_set_cache = ([]); }
f02d002000-03-18Martin Stjernholm 
996df72000-03-18Martin Stjernholm mapping(int|string:TagSet) local_tag_set_cache = garb_local_tag_set_cache();
f02d002000-03-18Martin Stjernholm 
8cb24d2000-02-13Martin Stjernholm // Various internal kludges.
23a0882000-08-12Martin Stjernholm static object/*(Parser.HTML)*/ charref_decode_parser; static void init_charref_decode_parser() { // Pretty similar to PEnt.. object/*(Parser.HTML)*/ p = Parser_HTML(); p->lazy_entity_end (1); p->add_entities (Roxen->parser_charref_table); p->_set_entity_callback ( lambda (object/*(Parser.HTML)*/ p) { string chref = p->tag_name(); if (sizeof (chref) && chref[0] == '#') if ((<"#x", "#X">)[chref[..1]]) { if (sscanf (chref, "%*2s%x%*c", int c) == 2) return ({(string) ({c})}); } else if (sscanf (chref, "%*c%d%*c", int c) == 2) return ({(string) ({c})}); parse_error ("Cannot decode character entity reference %O.\n", p->current()); }); p->_set_tag_callback ( lambda (object/*(Parser.HTML)*/ p) { parse_error ("Cannot convert XML value to text " "since it contains a tag %O.\n", p->current()); }); charref_decode_parser = p; }
5ed0132000-02-13Martin Stjernholm static function(string,mixed...:void) _run_error = run_error; static function(string,mixed...:void) _parse_error = parse_error;
ed81751999-12-11Martin Stjernholm  // Argh!
8cb24d2000-02-13Martin Stjernholm static program PXml;
3187d82000-01-28Martin Stjernholm static program PEnt;
ed81751999-12-11Martin Stjernholm static program PExpr;
23a0882000-08-12Martin Stjernholm static program Parser_HTML = master()->resolv ("Parser.HTML");
51f88b2000-06-23Martin Stjernholm 
ed81751999-12-11Martin Stjernholm void _fix_module_ref (string name, mixed val) { mixed err = catch { switch (name) {
8cb24d2000-02-13Martin Stjernholm  case "PXml": PXml = [program] val; break;
3187d82000-01-28Martin Stjernholm  case "PEnt": PEnt = [program] val; break;
ed81751999-12-11Martin Stjernholm  case "PExpr": PExpr = [program] val; break;
23a0882000-08-12Martin Stjernholm  case "Roxen": Roxen = [object] val; init_charref_decode_parser(); break;
1b2b752000-01-07Martin Stjernholm  case "empty_tag_set": empty_tag_set = [object(TagSet)] val; break;
ed81751999-12-11Martin Stjernholm  default: error ("Herk\n"); } }; if (err) werror (describe_backtrace (err)); }