harbour-core/src/rtl/langapi.c

/*
 * The Language API
 *
 * Copyright 1999-2001 Viktor Szakats (vszakats.net/harbour)
 *
 * 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, 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; see the file LICENSE.txt.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA (or visit https://www.gnu.org/licenses/).
 *
 * As a special exception, the Harbour Project gives permission for
 * additional uses of the text contained in its release of Harbour.
 *
 * The exception is that, if you link the Harbour libraries with other
 * files to produce an executable, this does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * Your use of that executable is in no way restricted on account of
 * linking the Harbour library code into it.
 *
 * This exception does not however invalidate any other reasons why
 * the executable file might be covered by the GNU General Public License.
 *
 * This exception applies only to the code released by the Harbour
 * Project under the name Harbour.  If you copy code from other
 * Harbour Project or Free Software Foundation releases into a copy of
 * Harbour, as the General Public License permits, the exception does
 * not apply to the code that you add in this way.  To avoid misleading
 * anyone as to the status of such modified files, you must delete
 * this exception notice from them.
 *
 * If you write modifications of your own for Harbour, it is your choice
 * whether to permit this exception to apply to your modifications.
 * If you do not wish that, delete this exception notice.
 *
 */

#include "hbapi.h"
#include "hbapilng.h"
#include "hbapicdp.h"
#include "hbapierr.h"

static HB_LANG s_lang_en =
{
   {
      /* Identification */

      "en",                        /* ISO ID (2 chars) */
      "English",                   /* Name (in English) */
      "English",                   /* Name (in native language) */
      "EN",                        /* RFC ID */
      "UTF8",                      /* Codepage */
      "",                          /* Version */

      /* Month names */

      "January",
      "February",
      "March",
      "April",
      "May",
      "June",
      "July",
      "August",
      "September",
      "October",
      "November",
      "December",

      /* Day names */

      "Sunday",
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday",

      /* CA-Cl*pper compatible natmsg items */

      "Database Files    # Records    Last Update     Size",
      "Do you want more samples?",
      "Page No.",
      "** Subtotal **",
      "* Subsubtotal *",
      "*** Total ***",
      "Ins",
      "   ",
      "Invalid date",
      "Range: ",
      " - ",
      "Y/N",
      "INVALID EXPRESSION",

      /* Error description names */

      "Unknown error",
      "Argument error",
      "Bound error",
      "String overflow",
      "Numeric overflow",
      "Zero divisor",
      "Numeric error",
      "Syntax error",
      "Operation too complex",
      "",
      "",
      "Memory low",
      "Undefined function",
      "No exported method",
      "Variable does not exist",
      "Alias does not exist",
      "No exported variable",
      "Illegal characters in alias",
      "Alias already in use",
      "",
      "Create error",
      "Open error",
      "Close error",
      "Read error",
      "Write error",
      "Print error",
      "",
      "",
      "",
      "",
      "Operation not supported",
      "Limit exceeded",
      "Corruption detected",
      "Data type error",
      "Data width error",
      "Workarea not in use",
      "Workarea not indexed",
      "Exclusive required",
      "Lock required",
      "Write not allowed",
      "Append lock failed",
      "Lock Failure",
      "",
      "",
      "",
      "Object destructor failure",
      "array access",
      "array assign",
      "array dimension",
      "not an array",
      "conditional",

      /* Internal error names */

      "Unrecoverable error %d: ",
      "Error recovery failure",
      "No ERRORBLOCK() for error",
      "Too many recursive error handler calls",
      "RDD invalid or failed to load",
      "Invalid method type from %s",
      "hb_xgrab can't allocate memory",
      "hb_xrealloc called with a NULL pointer",
      "hb_xrealloc called with an invalid pointer",
      "hb_xrealloc can't reallocate memory",
      "hb_xfree called with an invalid pointer",
      "hb_xfree called with a NULL pointer",
      "Can\'t locate the starting procedure: \'%s\'",
      "No starting procedure",
      "Unsupported VM opcode",
      "Symbol item expected from %s",
      "Invalid symbol type for self from %s",
      "Codeblock expected from %s",
      "Incorrect item type on the stack trying to pop from %s",
      "Stack underflow",
      "An item was going to be copied to itself from %s",
      "Invalid symbol item passed as memvar %s",
      "Memory buffer overflow",
      "hb_xgrab requested to allocate zero bytes",
      "hb_xrealloc requested to resize to zero bytes",
      "hb_xalloc requested to allocate zero bytes",

      /* Texts */

      "YYYY/MM/DD", /* NOTE: Use YYYY for year, MM for month and DD for days. */
      "Y",
      "N"
   }
};

HB_LANG_ANNOUNCE( EN )

/* Always link in the default language */
#if 0
HB_LANG_REQUEST( HB_LANG_DEFAULT );
#endif

/* NOTE: This is the maximum number of registered languages, later this can be
         made dynamic. */
#define HB_LANG_MAX_              128

#define HB_LANG_ITEM_ID_ID        0
#define HB_LANG_ITEM_ID_NAME      1
#define HB_LANG_ITEM_ID_NAMENAT   2
#define HB_LANG_ITEM_ID_CODEPAGE  4

typedef struct
{
   const char * pItemList[ HB_LANG_ITEM_MAX_ ];
}
HB_LANG_TRANS, * PHB_LANG_TRANS;

typedef struct
{
   PHB_LANG lang;
   void *   buffer;
}
HB_LANG_BASE, * PHB_LANG_BASE;

static HB_LANG_BASE s_langList[ HB_LANG_MAX_ ] = { { &s_lang_en, NULL } };

static void hb_langRelease( PHB_LANG_BASE pBase )
{
   if( pBase->lang )
   {
      if( pBase->buffer )
      {
         hb_xfree( pBase->buffer );
         pBase->buffer = NULL;
      }
      pBase->lang = pBase == s_langList ? &s_lang_en : NULL;
   }
}

static PHB_LANG_BASE hb_langFindBase( const char * pszID )
{
   PHB_LANG_BASE pBase = NULL;

   if( pszID )
   {
      int iPos;

      for( iPos = 0; iPos < HB_LANG_MAX_; iPos++ )
      {
         if( s_langList[ iPos ].lang != NULL )
         {
            if( hb_stricmp( s_langList[ iPos ].lang->pItemList[ HB_LANG_ITEM_BASE_ID + HB_LANG_ITEM_ID_ID ], pszID ) == 0 )
               return &s_langList[ iPos ];
         }
         else if( pBase == NULL )
            pBase = &s_langList[ iPos ];
      }
   }

   return pBase;
}


static HB_BOOL hb_langTranslate( const char * szNewId, PHB_LANG lang, PHB_CODEPAGE cdpIn, PHB_CODEPAGE cdpOut )
{
   PHB_LANG_BASE pBase;
   HB_LANG_TRANS trans;
   char *        buffer, * ptr;
   HB_SIZE       nSize;
   int i;

   if( ! szNewId || *szNewId == 0 || ! lang || ! cdpIn || ! cdpOut || cdpIn == cdpOut )
      return HB_FALSE;

   memset( &trans, 0, sizeof( trans ) );
   nSize = sizeof( trans );

   for( i = 0; i < HB_LANG_ITEM_MAX_; ++i )
   {
      char * pszTrans;

      if( i == HB_LANG_ITEM_BASE_ID + HB_LANG_ITEM_ID_ID )
         pszTrans = hb_strdup( szNewId );
      else if( i == HB_LANG_ITEM_BASE_ID + HB_LANG_ITEM_ID_CODEPAGE )
         pszTrans = hb_strdup( cdpOut->id );
      else
         pszTrans = hb_cdpDup( lang->pItemList[ i ], cdpIn, cdpOut );

      if( strcmp( pszTrans, lang->pItemList[ i ] ) != 0 )
      {
         trans.pItemList[ i ] = pszTrans;
         nSize += strlen( pszTrans ) + 1;
      }
      else
         hb_xfree( pszTrans );
   }

   buffer = ( char * ) hb_xgrab( nSize );
   ptr    = buffer + sizeof( trans );
   for( i = 0; i < HB_LANG_ITEM_MAX_; ++i )
   {
      if( trans.pItemList[ i ] != NULL )
      {
         HB_SIZE nLen = strlen( trans.pItemList[ i ] ) + 1;
         memcpy( ptr, trans.pItemList[ i ], nLen );
         hb_xfree( HB_UNCONST( trans.pItemList[ i ] ) );
         trans.pItemList[ i ] = ptr;
         ptr += nLen;
      }
      else
         trans.pItemList[ i ] = lang->pItemList[ i ];
   }
   memcpy( buffer, &trans, sizeof( trans ) );

   pBase = hb_langFindBase( szNewId );
   if( pBase && pBase->lang == NULL )
   {
      pBase->lang   = ( PHB_LANG ) buffer;
      pBase->buffer = ( void * ) buffer;
      return HB_TRUE;
   }

   hb_xfree( buffer );
   return HB_FALSE;
}

void hb_langReleaseAll( void )
{
   int iPos;

   HB_TRACE( HB_TR_DEBUG, ( "hb_langReleaseAll()" ) );

   for( iPos = 0; iPos < HB_LANG_MAX_; iPos++ )
      hb_langRelease( &s_langList[ iPos ] );
}

HB_BOOL hb_langRegister( PHB_LANG lang )
{
   HB_TRACE( HB_TR_DEBUG, ( "hb_langRegister(%p)", ( const void * ) lang ) );

   if( lang )
   {
      PHB_LANG_BASE pBase = hb_langFindBase( lang->pItemList[ HB_LANG_ITEM_BASE_ID + HB_LANG_ITEM_ID_ID ] );

      if( pBase && pBase->lang == NULL )
      {
         pBase->lang = lang;
         return HB_TRUE;
      }
   }

   return HB_FALSE;
}

PHB_LANG hb_langFind( const char * pszID )
{
   PHB_LANG_BASE pBase;

   HB_TRACE( HB_TR_DEBUG, ( "hb_langFind(%s)", pszID ) );

   pBase = hb_langFindBase( pszID );

   return pBase ? pBase->lang : NULL;
}

PHB_LANG hb_langSelect( PHB_LANG lang )
{
   PHB_LANG langOld;

   HB_TRACE( HB_TR_DEBUG, ( "hb_langSelect(%p)", ( const void * ) lang ) );

   langOld = hb_vmLang();
   if( lang )
      hb_vmSetLang( lang );

   return langOld;
}

const char * hb_langSelectID( const char * pszID )
{
   const char * pszIDOld = hb_langID();
   PHB_LANG     lang;

   HB_TRACE( HB_TR_DEBUG, ( "hb_langSelectID(%s)", pszID ) );

   lang = hb_langFind( pszID );
   if( lang )
      hb_langSelect( lang );
   else
      hb_errRT_BASE( EG_ARG, 1303, NULL, HB_ERR_FUNCNAME, HB_ERR_ARGS_BASEPARAMS );

   return pszIDOld;
}

const char * hb_langGetItem( const char * pszID, int iIndex )
{
   PHB_LANG lang;

   HB_TRACE( HB_TR_DEBUG, ( "hb_langGetItem(%s,%i)", pszID ? pszID : "(null)", iIndex ) );

   lang = pszID ? hb_langFind( pszID ) : hb_vmLang();
   if( lang && iIndex >= 0 && iIndex < HB_LANG_ITEM_MAX_ )
      return lang->pItemList[ iIndex ];
   else
      return NULL;
}

const char * hb_langID( void )
{
   HB_TRACE( HB_TR_DEBUG, ( "hb_langID()" ) );

   return hb_langGetItem( NULL, HB_LANG_ITEM_BASE_ID + HB_LANG_ITEM_ID_ID );
}

/* NOTE: Caller must free the pointer. */

char * hb_langName( const char * pszID )
{
   char *   pszName;
   PHB_LANG lang;

   lang = pszID ? hb_langFind( pszID ) : hb_vmLang();
   if( lang )
   {
      pszName = ( char * ) hb_xgrab( 128 );
      hb_snprintf( pszName, 128, "Harbour Language: %s %s (%s)",
                   hb_langGetItem( pszID, HB_LANG_ITEM_BASE_ID + HB_LANG_ITEM_ID_ID ),
                   hb_langGetItem( pszID, HB_LANG_ITEM_BASE_ID + HB_LANG_ITEM_ID_NAME ),
                   hb_langGetItem( pszID, HB_LANG_ITEM_BASE_ID + HB_LANG_ITEM_ID_NAMENAT ) );
   }
   else
      pszName = hb_strdup( "Harbour Language: (not installed)" );

   return pszName;
}

/* Compatibility interfaces */

const char * hb_langDGetErrorDesc( int iIndex )
{
   HB_TRACE( HB_TR_DEBUG, ( "hb_langDGetErrorDesc(%i)", iIndex ) );

   return hb_langGetItem( NULL, HB_LANG_ITEM_BASE_ERRDESC + iIndex );
}

const char * hb_langDGetItem( int iIndex )
{
   PHB_LANG lang;

   HB_TRACE( HB_TR_DEBUG, ( "hb_langDGetItem(%i)", iIndex ) );

   lang = hb_vmLang();
   if( lang && iIndex >= 0 && iIndex < HB_LANG_ITEM_MAX_ )
      return lang->pItemList[ iIndex ];
   else
      return NULL;
}

/* Harbour interface */

HB_FUNC( __HB_LANGSELECT )
{
   const char * szNewLang;

   hb_retc( hb_langID() );

   szNewLang = hb_parc( 1 );
   if( szNewLang )
      hb_langSelectID( szNewLang );
}

HB_FUNC( HB_LANGNAME )
{
   hb_retc_buffer( hb_langName( hb_parc( 1 ) ) );
}

HB_FUNC( HB_LANGERRMSG )
{
   hb_retc_const( hb_langDGetErrorDesc( hb_parnl( 1 ) ) );
}

HB_FUNC( HB_LANGMESSAGE )
{
   hb_retc_const( hb_langGetItem( hb_parc( 2 ), hb_parnl( 1 ) ) );
}

/* hb_langNew( <cNewLangId>, <cNewLangCpId>,
 *             <cLangId>, <cLangCpId> ) --> <lOK>
 */
HB_FUNC( HB_LANGNEW )
{
   hb_retl( hb_langTranslate( hb_parc( 1 ), hb_langFind( hb_parc( 3 ) ),
                              hb_cdpFindExt( hb_parc( 4 ) ),
                              hb_cdpFindExt( hb_parc( 2 ) ) ) );
}