plggen.sps

Oracle PL/SQL procedure generator (second generator type)

   c_cgml_set_options VARCHAR2(2000) :=
      'TARGET,CREATE_AT,OBJNAME,SCHEMA,DBOBJNAME,DBSCHEMA,TABFORVIEW,' ||
      'ARRAYNAME,TARGET_SCHEMA,PKGNAME,PKYNAME,PKYCOLNAME,PROGNAME,' ||
      'ARRAYDELIM,DRIVER,OBJECT,INDENT,DRIVERTYPE,ALIASTAG,OBJECTTAG,COMMENT,';

   c_comment CONSTANT CHAR(2) := '#%';

   g_hashing BOOLEAN := FALSE;

   PROCEDURE set_objtag_bracket (ochar IN CHAR, cchar IN CHAR);
   FUNCTION objtagopen RETURN CHAR;
   FUNCTION objtagclose RETURN CHAR;

   FUNCTION strbyname (
	   drv IN VARCHAR2,
      name_in IN VARCHAR2,
      op                 IN   VARCHAR2 := objtagopen,
      cl                 IN   VARCHAR2 := objtagclose,
      sch IN VARCHAR2 := NULL,
      context_in IN VARCHAR2 := NULL,
      expandalias_only IN BOOLEAN := FALSE)
   RETURN VARCHAR2;

   PROCEDURE substitute_string (
      drv IN VARCHAR2,
      str IN OUT VARCHAR2,
      embed_in_quotes IN BOOLEAN := FALSE,
      subst_db_tags IN BOOLEAN := TRUE,
      subst_db_open IN VARCHAR2 := NULL,
      subst_db_close IN VARCHAR2 := NULL,
      use_tag_example IN BOOLEAN := FALSE,
      sch IN VARCHAR2 := NULL,
      context_in IN VARCHAR2 := NULL,
      expandalias_only IN BOOLEAN := FALSE);

   FUNCTION substitute_string (
      drv IN VARCHAR2,
      str IN VARCHAR2,
      embed_in_quotes IN BOOLEAN := FALSE,
      subst_db_tags IN BOOLEAN := TRUE,
      subst_db_open IN VARCHAR2 := NULL,
      subst_db_close IN VARCHAR2 := NULL,
      use_tag_example IN BOOLEAN := FALSE,
      sch IN VARCHAR2 := NULL,
      context_in IN VARCHAR2 := NULL)
   RETURN VARCHAR2;

   /* Same as substitute_string. Here for backward compatibility. */
   PROCEDURE subst_string (
      drv IN VARCHAR2,
      str IN OUT VARCHAR2,
      embed_in_quotes IN BOOLEAN := FALSE,
      subst_db_tags IN BOOLEAN := TRUE,
      subst_db_open IN VARCHAR2 := NULL,
      subst_db_close IN VARCHAR2 := NULL,
      use_tag_example IN BOOLEAN := FALSE,
      sch IN VARCHAR2 := NULL,
      context_in IN VARCHAR2 := NULL,
      expandalias_only IN BOOLEAN := FALSE);

   FUNCTION subst_string (
      drv IN VARCHAR2,
      str IN VARCHAR2,
      embed_in_quotes IN BOOLEAN := FALSE,
      subst_db_tags IN BOOLEAN := TRUE,
      subst_db_open IN VARCHAR2 := NULL,
      subst_db_close IN VARCHAR2 := NULL,
      use_tag_example IN BOOLEAN := FALSE,
      sch IN VARCHAR2 := NULL,
      context_in IN VARCHAR2 := NULL)
   RETURN VARCHAR2;

   PROCEDURE load_dbobject_list (
      typ IN VARCHAR2,
      drv IN VARCHAR2,
      tab IN VARCHAR2,
      sch IN VARCHAR2 := NULL,
      regonly IN BOOLEAN := FALSE,
      objrequired IN BOOLEAN := TRUE
      );

   PROCEDURE load_datasource (
      /* 9/99 Not needed here drv IN VARCHAR2, */
      tab IN VARCHAR2,
      sch IN VARCHAR2,
      target_schema IN VARCHAR2 := NULL
      );

   PROCEDURE init_driver (drv IN VARCHAR2);

   PROCEDURE load_driver (
      drv IN VARCHAR2,
      tab IN VARCHAR2,
      sch IN VARCHAR2 := NULL,
      force_reload IN BOOLEAN := FALSE
      );

   PROCEDURE analyze_db_object (
      typ IN VARCHAR2,
      obj IN VARCHAR2,
      sch IN VARCHAR2 := NULL,
      dbtab IN VARCHAR2 := NULL,
      dbsch IN VARCHAR2 := NULL
      );

   PROCEDURE analyze_table (
      tab IN VARCHAR2,
      sch IN VARCHAR2 := NULL,
      dbtab IN VARCHAR2 := NULL,
      dbsch IN VARCHAR2 := NULL
      );

/* Generate Engine. */

   PROCEDURE initenv (listonly IN BOOLEAN := FALSE);

   PROCEDURE process_drvsrc (
      drvrec IN OUT PLGdoir.drvrec_t,
      compile IN BOOLEAN := FALSE);

   PROCEDURE process_drvsrc (
       name_in IN VARCHAR2,
       seq_in IN INTEGER,
       ftype_in IN INTEGER,
       use_file_in IN BOOLEAN,
       compile IN BOOLEAN := FALSE
       );

   PROCEDURE process_prep_and_cust_drvsrc (
      drv IN VARCHAR2,
      tab IN VARCHAR2,
      sch IN VARCHAR2);

   PROCEDURE translate_driver
      (drvrec IN OUT PLGdoir.drvrec_t,
       writeto IN OUT code_target_t,
       set_inout IN OUT PLS_INTEGER,
       start_in IN PLS_INTEGER := NULL,
       end_in IN PLS_INTEGER := NULL,
       between_in IN VARCHAR2 := NULL,
       append_in IN VARCHAR2 := NULL
       );

   PROCEDURE show_invalid_idents;

   PROCEDURE forobj (
      driver IN VARCHAR2,
      obj IN VARCHAR2,
      sch IN VARCHAR2 := NULL,
      target_schema IN VARCHAR2 := NULL,
      compile IN BOOLEAN := FALSE,
      regonly IN BOOLEAN := FALSE,
      metaonly IN BOOLEAN := FALSE,
      objrequired IN BOOLEAN := TRUE,
      single_pass IN BOOLEAN := FALSE
      );

   PROCEDURE fortab (
      driver IN VARCHAR2,
      tab IN VARCHAR2,
      parameters IN PLGadmin.vc2000_tabtype,
      sch IN VARCHAR2 := NULL,
      target_schema IN VARCHAR2 := NULL,
      compile IN BOOLEAN := FALSE,
      regonly IN BOOLEAN := FALSE,
      metaonly IN BOOLEAN := FALSE,
      objrequired IN BOOLEAN := TRUE,
      single_pass IN BOOLEAN := FALSE
      );

   PROCEDURE fortab (
      driver IN VARCHAR2,
      tab IN VARCHAR2,
      sch IN VARCHAR2 := NULL,
      target_schema IN VARCHAR2 := NULL,
      compile IN BOOLEAN := FALSE,
      regonly IN BOOLEAN := FALSE,
      metaonly IN BOOLEAN := FALSE,
      objrequired IN BOOLEAN := TRUE,
      single_pass IN BOOLEAN := FALSE
      );

   PROCEDURE fromlist (
      driver IN VARCHAR2,
      obj IN VARCHAR2,
      list IN PLGadmin.vc2000_tabtype,
      sch IN VARCHAR2 := NULL,
      target_schema IN VARCHAR2 := NULL,
      regonly IN BOOLEAN := FALSE,
      objrequired IN BOOLEAN := TRUE,
      single_pass IN BOOLEAN := FALSE
      );

   PROCEDURE register_generation (
      drv IN VARCHAR2,
      tab IN VARCHAR2,
      sch IN VARCHAR2,
      targsch IN VARCHAR2 := NULL,
      saving IN BOOLEAN := FALSE
      );

   PROCEDURE collect_garbage (is_finale IN BOOLEAN := FALSE);

   /* Perform CGML cleanup */
   PROCEDURE docleanup;
   PROCEDURE showcleanup;
   
/* Auto-commit feature */

   PROCEDURE autocommit;
   PROCEDURE noautocommit; /* Default */
   FUNCTION autocommitting RETURN BOOLEAN;

/* Debug trace mechanism */

   PROCEDURE dbg (
      srcnum IN INTEGER := 0,
      file IN VARCHAR2 := NULL);
      /*
         -1 = prep file
         -2 = customization file
          0 = all files
          N = specific file
      */

   PROCEDURE nodbg;
   FUNCTION debugging (srcnum IN INTEGER := 0) RETURN BOOLEAN;

   PROCEDURE set_maxiterations (num IN INTEGER);
   FUNCTION maxiterations RETURN INTEGER;

   PROCEDURE regen (
      driver IN VARCHAR2,
      tab IN VARCHAR2 := NULL,
      sch IN VARCHAR2 := NULL
      );

   PROCEDURE set_alias_bracket (ochar IN CHAR, cchar IN CHAR);
   FUNCTION aliasopen RETURN CHAR;
   FUNCTION aliasclose RETURN CHAR;
   
   PROCEDURE set_idtag (tagchar IN CHAR);
   FUNCTION idtag RETURN CHAR;

   PROCEDURE show_drv_array (seq IN PLS_INTEGER, num IN PLS_INTEGER := NULL);

   PROCEDURE check_idents;
   PROCEDURE nocheck_idents;
   FUNCTION checking_identifiers RETURN BOOLEAN;

   /* Disabled
   PROCEDURE aliascache_define (str IN VARCHAR2, delim IN VARCHAR2 := ',');
   FUNCTION inaliascache (str IN VARCHAR2) RETURN BOOLEAN;
   PROCEDURE use_aliascache;
   PROCEDURE nouse_aliascache;
   FUNCTION using_aliascache RETURN BOOLEAN;
   */

   PROCEDURE init_express_version;
   FUNCTION is_express_version RETURN BOOLEAN;

   /* Reset values to ensure reload of driver. */
   PROCEDURE reset;

   /* Display generated text to the screen? */
   PROCEDURE display;
   PROCEDURE nodisplay;
   FUNCTION displaying RETURN BOOLEAN;

   /* Extract generated text from list. */
   PROCEDURE list_init;
   FUNCTION next_list_entry RETURN VARCHAR2;
   FUNCTION end_of_list RETURN BOOLEAN;
   PROCEDURE list_clear;
   FUNCTION list_count RETURN PLS_INTEGER;

   /* For use by fromlist and PLGcgml.genstring to facilitate
      processing of a single large string (via list) as the 
      input of a driver source.
   */
   PROCEDURE useOneOutList;
   PROCEDURE useMultiOutLists;
   FUNCTION OneOutList RETURN BOOLEAN;

   FUNCTION reading_dbtab RETURN BOOLEAN;
   FUNCTION reading_file RETURN BOOLEAN;
   FUNCTION reading_list RETURN BOOLEAN;
   FUNCTION writing_dbtab RETURN BOOLEAN;
   FUNCTION writing_file RETURN BOOLEAN;
   FUNCTION writing_list RETURN BOOLEAN;

   FUNCTION is_cgml_start_command (text_in IN VARCHAR2) RETURN BOOLEAN;

   /* 2000.2  */
   PROCEDURE usenamex;
   PROCEDURE nousenamex;
   FUNCTION usingnamex RETURN BOOLEAN;

END PLGgen;
/