File /std/basic/id_match.c

Written by Pinkfish.

Includes

Method index

• is_matching_object(string *, object, class obj_match_context)
  This method is used by upper objects that only wish to match the ids and not mess with all the context stuff.
• parse_match_object(string *, object, class obj_match_context)
  This code is for the new parser.
• query_no_all()
  This method returns the no all flag's current value.
• set_no_all(int)
  This sets the no all flag.
• update_parse_match_context(class obj_match_context, int, int)
  This method updates the context.

Public Functions

These are functions that everyone can access.

.

parse_match_object

mixed parse_match_object(string * input,
                         object viewer,
                         class obj_match_context context)


This code is for the new parser... It returns an array which contains two elements. The first is the type of the match, plural or singular, and the second is the object it matched. Usualy this_object() but it can be used to swap new objects.

• Parameters:
  input - the input string
  viewer - the person viewing the object
  context - the contex this is to be taken in
• Returns:
  ({ type, ob }), 0 on failure

query_no_all

int query_no_all()


This method returns the no all flag's current value. If this flag is set to true then the object will not respond to 'all' requests and must be accessed with it's real name.

• Returns:
  the current value of the flag

  Protected Functions

  These are functions that only objects inheriting the class can access.
  is_matching_object

  int is_matching_object(string * input,
                         object viewer,
                         class obj_match_context context)
  

  
  This method is used by upper objects that only wish to match the ids and not mess with all the context stuff. This method will return a combination of OBJ_PARSER_MATCH_SINGULAR and OBJ_PARSER_MATCH_PLURAL.
  
  • Parameters:
    input - the input string
    viewer - the person viewing the object
    context - the contex this is to be taken in
  • Returns:
    the singular/plural match flags
    set_no_all

    void set_no_all(int no_all)
    

    
    This sets the no all flag. If this flag is set to true then the object will not respond to 'all' requests and must be accessed with it's real name.
    
    • Parameters:
      no_all - the no all flag value
      update_parse_match_context

      int update_parse_match_context(class obj_match_context context,
                                     int num,
                                     int singular)
      

      
      This method updates the context. It returns the number of the objects we match, and you pass in the number of objects that we are.
      
      • Parameters:
        context - the context to update
        num - the number of objects
        singular - return from is_matching_object
      • Returns:
        the number of matched objects