misc.h

/* $Id: misc.h,v 1.35 2007/09/11 08:48:31 vlad Exp $ */

#ifndef __misc_h

#define __misc_h


#ifdef __cplusplus
extern "C"
{
#endif

/*===========================================================*
 *
 * Functions that useful in many situations and circumstances,
 * but they don't have common specialization.
 *
 *===========================================================*/

#include <string.h> /* for size_t */

#include <mix/Types.h>
#include <mix/PortableDirs.h>
#include <mix/char2ops.h>


char*   ltoa (char* s, long n);

char*   lltoa (char* s, long long n);

void*   mem_copy (void* dst, const void* src, size_t sz);


Logic   isspacechar (char c);


  char*     strmalloc (int n);

  char*     stralloc (const char* s);

  void      strfree (char* s);

  /* STRLIST is equal to char** for *NIX and may be SAFEARRAY* on
     Win32 (see mix/portability.h) */


  STRLIST   strlistalloc (int n);

  STRLIST   strlistdup (STRLIST slist, int n);

  void      strlistfree (STRLIST slist, int n);

  char*     strlistgetitem (STRLIST slist, int i);

  void      strlistputitem (STRLIST slist, int i, const char* s);

char*   strword (char* str);

char*   strstripspaces (char* s);

const char* strlword (const char* s);

int strrcmp (const char* s1, const char* s2);


int strrmatch (const char* s1, const char* s2);


Logic   stronlyspaces (const char* s);

Logic   strcaseeq (const char* s1, const char* s2);


char*   strreplacebadch (char* s, char c);


char*   strtoupper (char* s);

char*   strtolower (char* s);

char*   strnsepcpy (char* dst, const char* src, size_t n, char sep);


#define CHCL_EOS    (1<<0)  
#define CHCL_EOL    (1<<1)  
#define CHCL_SPACE  (1<<2)  
#define CHCL_PUNCT  (1<<3)  
#define CHCL_ALPHA  (1<<4)  
#define CHCL_DIGIT  (1<<5)  
char*   chcl_skip (const char* s, int char_classes);

int chcl_class (const char* s);

double  Round (double x);


/*************************************************************
 * Timer support: stop_timer() returns time in microseconds.
 * MT-Safe
 *************************************************************/

void        start_timer ();

unsigned long   stop_timer ();

void        sleep_awhile (unsigned long usec);


int DebugLevel ();


/*************************************************************
 * Tunable versatile quick sort procedure.
 *************************************************************/

typedef void    (*QsExchangeProc)(void* base, unsigned i1, unsigned i2);
typedef Compar  (*QsCompareProc)(void* base, unsigned i1, unsigned i2);

void    QuickSort (void *base, unsigned num,
           QsExchangeProc pExchangeProc,
           QsCompareProc pCompareProc);


void    qs_strlist_exchange (void* base, unsigned i1, unsigned i2);

Compar  qs_strlist_compare (void* base, unsigned i1, unsigned i2);


/*************************************************************
 * Floating point formatting procedures and functions.
 *************************************************************/

int FracDigits (double h1, double h2);

/***********************************************************************
 * Packed format of number list.
 ***********************************************************************/

int parse_int_list (const char* s, int** list);

char*   produce_int_list (int n, int* list);


/*************************************************************
 *
 *                    Options buffer support.
 *
 * Options are represented in separate lines of text buffer
 * in format name=value with "\n" or "\r\n".  Name is
 * interpreted as the first word (spaces are skipped).  The
 * next token after the name must be '='.  The next
 * character is interpreted as value starting.  Value is
 * prolongated until the end of line except the case the
 * last character of the line is '\' and previous one is not
 * '\'.  In the last case value is prolongated to the next
 * line.  End-of-line characters are not included in the
 * value.  Between name=value lines the full line comments
 * started with '#' are accepted.
 *************************************************************/

  typedef struct
  {
    char    *name;      
    char    *value;     
  } OptionItem;

  typedef struct
  {
    int     items_num;  
    OptionItem  *items;     
  } OptionBase;

  int*  parse_options (const char* buf, OptionBase* base);

  int*  add_options (const char* buf, OptionBase* base);

  void  add_option_item (OptionBase* base,
             const char* name, const char* value);

  char* serialize_options (const OptionBase* base,
               const char* start_line, const char* end_line);

  OptionItem*   find_option (const OptionBase* base,
                 const char* name);

  OptionItem**  find_options (const OptionBase* base,
                  const char* startname);

  void  free_options (OptionBase* base);


  Logic parse_ini_section (const char* buf, char** word1, char** word2);


/*************************************************************
 *
 *               Support for enumerating labels.
 *                (very slow for large klars)
 *
 *************************************************************/

  typedef struct
  {
    int     key;    
    char    *label; 
  } KeyLabelItem;

  unsigned  find_index_by_label (const KeyLabelItem* klar,
                     unsigned klar_n,
                     const char* label);
  
  unsigned  find_index_by_key (const KeyLabelItem* klar,
                   unsigned klar_n,
                   int key);
  


/*************************************************************
 *
 *                   Bad floaing point numbers.
 *
 *************************************************************/

Logic   isNaNQ (float num);

Logic   isInf (float num);

Logic   isNaNQorInf (float num);

float   getNaNQ ();


/***********************************************************************
  Compute minimum and maximum value of the vector.
  Input parameters:
   a(n)  - input vector of samples;
   n     - sample count;
  Output parameters:
   mm[0] - minimum value
   mm[1] - maximum value
 ***********************************************************************/
void    vminmax (const float a[], int n, float mm[2]);



#ifdef __cplusplus
};
#endif

#endif  /* misc.h */