---

defs.hh

/*
*  Name:      defs.hh
*  Author:    Rafael Jesus Alcantara Perez
*  Summary:   UESQLC definitions
*  Date:      $Date: 2003/10/06 13:21:35 $
*  Revision:  $Revision: 1.1 $
*
*  Copyright (C) 1996-2002  Rafael Jesus Alcantara Perez <rafa@dedalo-ing.com>
*
*  This program is free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  This program is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with this program; if not, write to the Free Software
*  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
*  MA 02111-1307, USA.
*/

#ifndef _UESQL_DEFS__
#define _UESQL_DEFS__

#include <mpcl/error_exception.hh>
#include <mpcl/exceptions.hh>
#include <mpcl/text/string.hh>
#include <mpcl/util/collection/map.hh>
#include <mpcl/warning_exception.hh>
#include <uesqlc/date.hh>
#include <uesqlc/identifier.hh>
#include <uesqlc/integer.hh>
#include <uesqlc/real.hh>
#include <uesqlc/search_condition.hh>
#include <uesqlc/string.hh>
#include <uesqlc/time.hh>


namespace uesqlc
{
  
  //
  //  E X P O R T E D   V A R I A B L E S
  //

  //
  //  These variables are used in sources generated by UESQLC.
  //

  extern long int   SQLCODE;

  extern mpcl::text::TString   SQLMESSAGE;

  extern mpcl::text::TString   SQLSTATE;

  //
  //  SQLSTATE class and subclass values.
  //    Classes has been represented as a C++ namespace, and subclasses have
  //    been represented as a constant pointer to a zero terminated string.
  //

  namespace ambiguous_cursor_name
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS
    };
  }

  namespace cardinality_violation
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 1000
    };
  }
  
  namespace connection_exception
  {
    extern const char*   pkcNO_SUBCLASS;
    extern const char*   pkcCONNECTION_DOES_NOT_EXIST;
    extern const char*   pkcCONNECTION_FAILURE;
    extern const char*   pkcCONNECTION_NAME_IN_USE;
    extern const char*   pkcSQLCLIENT_UNABLE_TO_ESTABLISH_SQLCONNECTION;
    extern const char*   pkcSQLSERVER_REJECTED_ESTABLISHMENT_OF_SQLCONNECTION;
    extern const char*   pkcTRANSACTION_RESOLUTION_UNKNOWN;
    enum EValues
    {
      eNO_SUBCLASS = 2000                                ,
      eCONNECTION_DOES_NOT_EXIST                         ,
      eCONNECTION_FAILURE                                ,
      eCONNECTION_NAME_IN_USE                            ,
      eSQLCLIENT_UNABLE_TO_ESTABLISH_SQLCONNECTION       ,
      eSQLSERVER_REJECTED_ESTABLISHMENT_OF_SQLCONNECTION ,
      eTRANSACTION_RESOLUTION_UNKNOWN
    };
  }
  
  namespace data_exception
  {
    extern const char*   pkcNO_SUBCLASS;
    extern const char*   pkcCHARACTER_NOT_IN_REPERTOIRE;
    extern const char*   pkcDATETIME_FIELD_OVERFLOW;
    extern const char*   pkcDIVISION_BY_ZERO;
    extern const char*   pkcERROR_IN_ASSIGNMENT;
    extern const char*   pkcINDICATOR_OVERFLOW;
    extern const char*   pkcINTERVAL_FIELD_OVERFLOW;
    extern const char*   pkcINVALID_CHARACTER_VALUE_FOR_CAST;
    extern const char*   pkcINVALID_DATETIME_FORMAT;
    extern const char*   pkcINVALID_ESCAPE_CHARACTER;
    extern const char*   pkcINVALID_ESCAPE_SEQUENCE;
    extern const char*   pkcINVALID_PARAMETER_VALUE;
    extern const char*   pkcINVALID_TIME_ZONE_DISPLACEMENT_VALUE;
    extern const char*   pkcNULL_VALUE_NO_INDICATOR_PARAMETER;
    extern const char*   pkcNUMERIC_VALUE_OUT_OF_RANGE;
    extern const char*   pkcSTRING_DATA_LENGTH_MISMATCH;
    extern const char*   pkcSTRING_DATA_RIGHT_TRUNCATION;
    extern const char*   pkcSUBSTRING_ERROR;
    extern const char*   pkcTRIM_ERROR;
    extern const char*   pkcUNTERMINATED_C_STRING;
    enum EValues
    {
      eNO_SUBCLASS = 3000                   ,
      eCHARACTER_NOT_IN_REPERTOIRE          ,
      eDATETIME_FIELD_OVERFLOW              ,
      eDIVISION_BY_ZERO                     ,
      eERROR_IN_ASSIGNMENT                  ,
      eINDICATOR_OVERFLOW                   ,
      eINTERVAL_FIELD_OVERFLOW              ,
      eINVALID_CHARACTER_VALUE_FOR_CAST     ,
      eINVALID_DATETIME_FORMAT              ,
      eINVALID_ESCAPE_CHARACTER             ,
      eINVALID_ESCAPE_SEQUENCE              ,
      eINVALID_PARAMETER_VALUE              ,
      eINVALID_TIME_ZONE_DISPLACEMENT_VALUE ,
      eNULL_VALUE_NO_INDICATOR_PARAMETER    ,
      eNUMERIC_VALUE_OUT_OF_RANGE           ,
      eSTRING_DATA_LENGTH_MISMATCH          ,
      eSTRING_DATA_RIGHT_TRUNCATION         ,
      eSUBSTRING_ERROR                      ,
      eTRIM_ERROR                           ,
      eUNTERMINATED_C_STRING
    };
  }
  
  namespace dependent_privilege_descriptors_still_exist
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 4000
    };
  }
  
  namespace dynamic_sql_error
  {
    extern const char*   pkcNO_SUBCLASS;
    extern const char*   pkcCURSOR_SPECIFICATION_CANNOT_BE_EXECUTED;
    extern const char*   pkcINVALID_DESCRIPTOR_COUNT;
    extern const char*   pkcINVALID_DESCRIPTOR_INDEX;
    extern const char*   pkcPREPARED_STATEMENT_NOT_A_CURSOR_SPECIFICATION;
    extern const char*   pkcRESTRICTED_DATA_TYPE_ATTRIBUTE_VIOLATION;
    extern const char*   pkcUSING_CLAUSE_DOES_NOT_MATCH_DYNAMIC_PARAMETER_SPEC;
    extern const char*   pkcUSING_CLAUSE_DOES_NOT_MATCH_TARGET_SPEC;
    extern const char*   pkcUSING_CLAUSE_REQUIRED_FOR_DYNAMIC_PARAMETERS;
    extern const char*   pkcUSING_CLAUSE_REQUIRED_FOR_RESULT_FIELDS;
    enum EValues
    {
      eNO_SUBCLASS = 5000                                 ,
      eCURSOR_SPECIFICATION_CANNOT_BE_EXECUTED            ,
      eINVALID_DESCRIPTOR_COUNT                           ,
      eINVALID_DESCRIPTOR_INDEX                           ,
      ePREPARED_STATEMENT_NOT_A_CURSOR_SPECIFICATION      ,
      eRESTRICTED_DATA_TYPE_ATTRIBUTE_VIOLATION           ,
      eUSING_CLAUSE_DOES_NOT_MATCH_DYNAMIC_PARAMETER_SPEC ,
      eUSING_CLAUSE_DOES_NOT_MATCH_TARGET_SPEC            ,
      eUSING_CLAUSE_REQUIRED_FOR_DYNAMIC_PARAMETERS       ,
      eUSING_CLAUSE_REQUIRED_FOR_RESULT_FIELDS
    };
  }
  
  namespace feature_not_supported
  {
    extern const char*   pkcNO_SUBCLASS;
    extern const char*   pkcMULTIPLE_ENVIRONMENT_TRANSACTIONS;
    enum EValues
    {
      eNO_SUBCLASS = 6000                ,
      eMULTIPLE_ENVIRONMENT_TRANSACTIONS
    };
  }
  
  namespace integrity_constraint_violation
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 7000
    };
  }
  
  namespace invalid_authorization_specification
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 8000
    };
  }
  
  namespace invalid_catalog_name
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 9000
    };
  }
  
  namespace invalid_character_set_name
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 10000
    };
  }
  
  namespace invalid_condition_number
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 11000
    };
  }
  
  namespace invalid_connection_name
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 12000
    };
  }
  
  namespace invalid_cursor_name
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 13000
    };
  }
  
  namespace invalid_cursor_state
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 14000
    };
  }
  
  namespace invalid_schema_name
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 15000
    };
  }
  
  namespace invalid_sql_descriptor_name
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 16000
    };
  }
  
  namespace invalid_sql_statement_name
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 17000
    };
  }
  
  namespace invalid_transaction_state
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 18000
    };
  }
  
  namespace invalid_transaction_termination
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 19000
    };
  }
  
  namespace no_data
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 20000
    };
  }
  
  namespace remote_database_access
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 21000
    };
  }
  
  namespace successful_completion
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 22000
    };
  }
  
  namespace syntax_error_or_access_rule_violation
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 23000
    };
  }
  
  namespace syntax_error_or_access_rule_violation_in_direct_statement
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 24000
    };
  }
  
  namespace syntax_error_or_access_rule_violation_in_dynamic_statement
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 25000
    };
  }
  
  namespace transaction_rollback
  {
    extern const char*   pkcNO_SUBCLASS;
    extern const char*   pkcINTEGRITY_CONSTRAINT_VIOLATION;
    extern const char*   pkcSERIALIZATION_FAILURE;
    extern const char*   pkcSTATEMENT_COMPLETION_UNKNOWN;
    enum EValues
    {
      eNO_SUBCLASS = 26000            ,
      eINTEGRITY_CONSTRAINT_VIOLATION ,
      eSERIALIZATION_FAILURE          ,
      eSTATEMENT_COMPLETION_UNKNOWN
    };
  }
  
  namespace triggered_data_change_violation
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 27000
    };
  }
  
  namespace warning
  {
    extern const char*   pkcNO_SUBCLASS;
    extern const char*   pkcCURSOR_OPERATION_CONFLICT;
    extern const char*   pkcDISCONNECT_ERROR;
    extern const char*   pkcIMPLICIT_ZERO_BIT_PADDING;
    extern const char*   pkcINSUFFICIENT_ITEM_DESCRIPTOR_AREAS;
    extern const char*   pkcNULL_VALUE_ELIMINATED_IN_SET_FUNCTION;
    extern const char*   pkcPRIVILEGE_NOT_GRANTED;
    extern const char*   pkcPRIVILEGE_NOT_REVOKED;
    extern const char*   pkcQUERY_EXPRESSION_TOO_LONG_FOR_INFORMATION_SCHEMA;
    extern const char*   pkcSEARCH_CONDITION_TOO_LONG_FOR_INFORMATION_SCHEMA;
    extern const char*   pkcSTRING_DATA_RIGHT_TRUNCATION;
    enum EValues
    {
      eNO_SUBCLASS = 28000                              ,
      eCURSOR_OPERATION_CONFLICT                        ,
      eDISCONNECT_ERROR                                 ,
      eIMPLICIT_ZERO_BIT_PADDING                        ,
      eINSUFFICIENT_ITEM_DESCRIPTOR_AREAS               ,
      eNULL_VALUE_ELIMINATED_IN_SET_FUNCTION            ,
      ePRIVILEGE_NOT_GRANTED                            ,
      ePRIVILEGE_NOT_REVOKED                            ,
      eQUERY_EXPRESSION_TOO_LONG_FOR_INFORMATION_SCHEMA ,
      eSEARCH_CONDITION_TOO_LONG_FOR_INFORMATION_SCHEMA ,
      eSTRING_DATA_RIGHT_TRUNCATION
    };
  }
  
  namespace with_check_option_violation
  {
    extern const char*   pkcNO_SUBCLASS;
    enum EValues
    {
      eNO_SUBCLASS = 29000
    };
  }

  class TSqlstateDescriptor
  {

    private:

      static mpcl::util::collection::TMap<mpcl::text::TString, int>   _tValueToIntMap;


    protected:
      
      //
      //  L O C A L   F U N C T I O N S
      //

      static void _addCondition (const char* pkcSQLSTATE, int iVALUE);

      static void _initialize (void);
      
      
    public:

      //
      //  C O N S T R U C T O R S
      //

      TSqlstateDescriptor (void)
      {
        _initialize();
      }


    public:

      //
      //  S E L E C T O R S
      //

      bool queryIsEmpty (void) const
      {
        return ( getUniqueValue() == no_data::eNO_SUBCLASS );
      }

      bool queryHasSingleRow (void) const
      {
        //
        //  Check if query has generated only *one* row.
        //
        return ( ( getUniqueValue() != cardinality_violation::eNO_SUBCLASS ) &&
                 ( getUniqueValue() != no_data::eNO_SUBCLASS )                );
      }

      int getUniqueValue (void) const
      {
        using mpcl::text::TString;
        using mpcl::util::collection::TMap;

        TMap<TString, int>::const_iterator   I;
        register int                         iUniqueValue = -1;

        I = _tValueToIntMap.find (SQLSTATE);
        if ( I != _tValueToIntMap.end() )
        {
          iUniqueValue = I->second;
        }        
        return iUniqueValue;
      }

      int getUniqueValue (const char* pkcSQLSTATE) const
      {
        return _tValueToIntMap [pkcSQLSTATE];
      }

      const char* getClassValue (void) const
      {
        return getClassValue (SQLSTATE.c_str());
      }
      
      const char* getClassValue (const char* pkcSQLSTATE) const;
      
      mpcl::text::TString getDescription (const char* pkcSQLSTATE) const;
      
      const char* getSubclassValue (void) const
      {
        return getSubclassValue (SQLSTATE.c_str());
      }
      
      const char* getSubclassValue (const char* pkcSQLSTATE) const;

  };  // class TSqlstateDescriptor


  class TNotFoundException                 :
    public virtual mpcl::TException        ,
    public         mpcl::TWarningException ,
    private        TSqlstateDescriptor
  {

    public:

      TNotFoundException ( const char* pkcFILE_NAME  ,
                           const int   kiLINE_NUMBER );


    public:

      //
      //  S E L E C T O R S
      //

      const std::string what (void) const;

  };  // class TNotFoundException


  class TSqlerrorException               :
    public virtual mpcl::TException      ,
    public         mpcl::TErrorException ,
    private        TSqlstateDescriptor
  {

    public:

      TSqlerrorException ( const char* pkcFILE_NAME  ,
                           const int   kiLINE_NUMBER );


    public:

      //
      //  S E L E C T O R S
      //

      const std::string what (void) const;

  };  // class TSqlerrorException


  //
  //  E X P O R T E D   F U N C T I O N S
  //

  //
  //  Simple n-adic functions for embedded function calls.
  //

  TString ComposeSchemaLocation ( const std::string& rkyHOST_NAME   ,
                                  const std::string& rkySCHEMA_NAME );

  TString ComposeUserLogin ( const std::string& rkyUSER_NAME     ,
                             const std::string& rkyUSER_PASSWORD );

  TString ToString (bool gVALUE);
  
  TString ToString (long double ldNUMBER);
  
  TString ToString (long int liNUMBER);
  
  TString ToString (long unsigned int luiNUMBER);
  
}  // namespace uesqlc


#endif  // not _UESQL_DEFS__

---