workbench/libs/locale/getcatalogstr.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: english
   7 */
   8
   9 #include <exec/types.h>
  10 #include <proto/exec.h>
  11 #include "locale_intern.h"
  12
  13 /*****************************************************************************
  14
  15     NAME */
  16 #include <proto/locale.h>
  17
  18         AROS_LH3(CONST_STRPTR, GetCatalogStr,
  19
  20 /*  SYNOPSIS */
  21         AROS_LHA(const struct Catalog *, catalog,       A0),
  22         AROS_LHA(ULONG,                  stringNum,     D0),    /* Not a typo! Needs to be unsigned for ICF_INORDER */
  23         AROS_LHA(CONST_STRPTR,           defaultString, A1),
  24
  25 /*  LOCATION */
  26         struct LocaleBase *, LocaleBase, 12, Locale)
  27
  28 /*  FUNCTION
  29         This function will return the string specified by the
  30         stringNum from the given message catalog, or the defaultString
  31         if the string could not be found.
  32
  33         If the catalog == NULL, then the defaultString will also be
  34         returned.
  35
  36     INPUTS
  37         catalog -       Message catalog to search. May be NULL.
  38         stringNum -     ID of the string to find.
  39         defaultString - String to return in case catalog is NULL or
  40                         string could not be found.
  41
  42     RESULT
  43         A pointer to a READ ONLY NULL terminated string. This string
  44         pointer is valid as long as the catalog remains open.
  45
  46     NOTES
  47
  48     EXAMPLE
  49
  50     BUGS
  51
  52     SEE ALSO
  53         OpenCatalog(), CloseCatalog()
  54
  55     INTERNALS
  56
  57     HISTORY
  58         27-11-96    digulla automatically created from
  59                             locale_lib.fd and clib/locale_protos.h
  60
  61 *****************************************************************************/
  62 {
  63     AROS_LIBFUNC_INIT
  64
  65     CONST_STRPTR str = defaultString;
  66
  67     if(catalog != NULL)
  68     {
  69         struct CatStr *cs = IntCat(catalog)->ic_CatStrings;
  70         ULONG         numstrings = IntCat(catalog)->ic_NumStrings;
  71         ULONG         i = 0;
  72
  73         for(i = 0; i < numstrings; i++, cs++)
  74         {
  75             if(cs->cs_Id == stringNum)
  76             {
  77                 str = cs->cs_String;
  78                 break;
  79             }
  80             else
  81             {
  82                 if((IntCat(catalog)->ic_Flags & ICF_INORDER) &&
  83                    (cs->cs_Id > stringNum))
  84                 {
  85                     break;
  86                 }
  87             }
  88         }
  89     }
  90
  91     return str;
  92
  93     AROS_LIBFUNC_EXIT
  94
  95 } /* GetCatalogStr */