include/sphinxbase/case.h

   1 /* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
   2 /* ====================================================================
   3  * Copyright (c) 1999-2004 Carnegie Mellon University.  All rights
   4  * reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  *
  18  * This work was supported in part by funding from the Defense Advanced
  19  * Research Projects Agency and the National Science Foundation of the
  20  * United States of America, and the CMU Sphinx Speech Consortium.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
  23  * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
  26  * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  * ====================================================================
  35  *
  36  */
  37 /*
  38  * case.h -- Upper/lower case conversion routines
  39  *
  40  * **********************************************
  41  * CMU ARPA Speech Project
  42  *
  43  * Copyright (c) 1999 Carnegie Mellon University.
  44  * ALL RIGHTS RESERVED.
  45  * **********************************************
  46  *
  47  * HISTORY
  48  * $Log: case.h,v $
  49  * Revision 1.7  2005/06/22 02:58:54  arthchan2003
  50  * Added  keyword
  51  *
  52  * Revision 1.3  2005/03/30 01:22:48  archan
  53  * Fixed mistakes in last updates. Add
  54  *
  55  *
  56  * 18-Jun-97    M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon
  57  *              Added strcmp_nocase, UPPER_CASE and LOWER_CASE definitions.
  58  *
  59  * 16-Feb-97    M K Ravishankar (rkm@cs.cmu.edu) at Carnegie Mellon
  60  *              Created.
  61  */
  62
  63
  64 /**
  65  * @file case.h
  66  * @brief Locale-independent implementation of case swapping operation.
  67  *
  68  * This function implements ASCII-only case switching and comparison
  69  * related operations, which do not depend on the locale and are
  70  * guaranteed to exist on all versions of Windows.
  71  */
  72
  73 #ifndef _LIBUTIL_CASE_H_
  74 #define _LIBUTIL_CASE_H_
  75
  76 #include <string.h>
  77
  78 #include <sphinxbase/prim_type.h>
  79 #include <sphinxbase/sphinxbase_export.h>
  80
  81 #ifdef __cplusplus
  82 extern "C" {
  83 #endif
  84 #if 0
  85 /* Fool Emacs. */
  86 }
  87 #endif
  88
  89   /**
  90    * Return upper case form for c
  91    */
  92 #define UPPER_CASE(c)   ((((c) >= 'a') && ((c) <= 'z')) ? (c-32) : c)
  93
  94   /**
  95    * Return lower case form for c
  96    */
  97 #define LOWER_CASE(c)   ((((c) >= 'A') && ((c) <= 'Z')) ? (c+32) : c)
  98
  99
 100   /**
 101    * Convert str to all upper case.
 102    * @param str is a string.
 103    */
 104 SPHINXBASE_EXPORT
 105 void ucase(char *str);
 106
 107   /**
 108    * Convert str to all lower case
 109    * @param str is a string.
 110    */
 111 SPHINXBASE_EXPORT
 112 void lcase(char *str);
 113
 114   /**
 115    * (FIXME! The implementation is incorrect!)
 116    * Case insensitive string compare.  Return the usual -1, 0, +1, depending on
 117    * str1 <, =, > str2 (case insensitive, of course).
 118    * @param str1 is the first string.
 119    * @param str2 is the second string.
 120    */
 121 SPHINXBASE_EXPORT
 122 int32 strcmp_nocase(const char *str1, const char *str2);
 123
 124 /**
 125  * Like strcmp_nocase() but with a maximum length.
 126  */
 127 SPHINXBASE_EXPORT
 128 int32 strncmp_nocase(const char *str1, const char *str2, size_t len);
 129
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif