Copyright (C) by Intratek Computing, 1994-1995. All rights reserved.

Title  : SML BRIEF FUNCTION OVERVIEW
Version: 1.0.0


                       SML BRIEF FUNCTION OVERVIEW
        ----------------------------------------------------------

 [--- SML INITIALIZATION

 - sml_init()           Initialize SML package
 extern void sml_init(void);


 [--- SML ERROR CONTROL

 - sml_rerr()           Return error condition
 extern SML_ERROR sml_rerr(void);


 [--- STRING CREATION AND DESTRUCTION

 - sml_create()         String Create
 extern char * sml_create(const size_t size, const char *init_str);

 - sml_csize()          Create empty string
 extern char * sml_csize(const size_t n);

 - sml_ccopy()          Create Copy
 extern char * sml_ccopy(const char *str);

 - sml_mcat()           Multiple string concatenation
 extern char * sml_mcat(char *str, ...);

 - sml_free()           Free a dynamically created string
 extern void sml_free(char *str);


 [--- SUBSTRING RETURN

 - sml_nleft()          Return n characters from left of string
 extern char * sml_nleft(const char *str, const size_t n);

 - sml_nright()         Return n characters from right of string
 extern char * sml_nright(const char *str, const size_t n);

 - sml_nmid()           Return n characters from some position
 extern char * sml_nmid(const char *str, const size_t pos, const size_t n);

                                                                  12-94 i

                       SML BRIEF FUNCTION OVERVIEW
        ----------------------------------------------------------

 [--- SUBSTRING DELETION

 - sml_ndel()           Remove n characters from some position
 extern char * sml_ndel(char *str, const size_t pos, const size_t n);

 - sml_ssdel()          Remove sub-string from string
 extern char * sml_ssdel(char *str, char *del, const SML_CASE cs);

 - sml_cdel()           Strip undesired characters from string
 extern char * sml_cdel(char *str, const char c);


 [--- SUBSTRING PLACEMENT

 - sml_insert()         Insert a sub-string into some position
 extern char * sml_insert(char *str, const char *sub, const size_t pos);

 - sml_overlay()        Overlay a string with a sub-string
 extern char * sml_overlay(char *str, const char *sub, const size_t pos);


 [--- CONVERSION

 - sml_str2array()      Parse a string into an array of strings
 extern char ** sml_str2array(const char *orig_str, const char *tok);

 - sml_s2a_kill()       Remove an array created by sml_str2array()
 extern void sml_s2a_kill(char **array);

 - sml_array2str()      Convert array of strings to a string
 extern char * sml_array2str(const char **array, const char *tok);


 [--- EXCHANGE

 - sml_xchg()           String eXchange
 extern char * sml_xchg(char *str1, char *str2);


 [--- STRING FILL

 - sml_fill()           Fill string with a character
 extern char * sml_fill(char *str, const int c);

                                                                  12-94 ii

                       SML BRIEF FUNCTION OVERVIEW
        ----------------------------------------------------------

 - sml_nfill()          Fill string with a character n times at position
 extern char * sml_nfill(char *str, const int c, const size_t pos,
         const size_t n);


 [--- CONVERT TO CASE

 - sml_2upper()         Upper the case of a string
 extern char * sml_2upper(char *str);

 - sml_n2upper()        Upper the case of n characters at some position
 extern char * sml_n2upper(char *str, const size_t pos, const size_t n);

 - sml_2lower()         Lower the case of a string
 extern char * sml_2lower(char *str);

 - sml_n2lower()        Lower the case of n characters at some position
 extern char * sml_n2lower(char *str, const size_t pos, const size_t n);


 [--- SUBSTRING SEARCH

 - sml_psearch()        String search with pointer return
 extern char * sml_psearch(char *str1, char *str2, const SML_CASE cs);

 - sml_esearch()        String search with element return
 extern int sml_esearch(char *str1, char *str2, const SML_CASE cs);


 [--- JUSTIFICATION

 - sml_jleft()          Left justify string
 extern char * sml_jleft(char *str, const char pad, const size_t n);

 - sml_jright()         Right justify string
 extern char * sml_jright(char *str, const char pad, const size_t n);

 - sml_jcenter()        Center justify string
 extern char * sml_jcenter(char *str, const char pad, const size_t n);


 [--- ROTATION

 - sml_rrotate()        Rotate string right once
 extern char * sml_rrotate(char *str);

                                                                  12-94 iii

                       SML BRIEF FUNCTION OVERVIEW
        ----------------------------------------------------------

 - sml_nrrotate()       Rotate string right n times
 extern char * sml_nrrotate(char *str, const size_t n);

 - sml_lrotate()        Rotate string left once
 extern char * sml_lrotate(char *str);

 - sml_nlrotate()       Rotate string left n times
 extern char * sml_nlrotate(char *str, const size_t n);

                                                                  12-94 iv
