canonical_string.h

Go to the documentation of this file.

#ifndef CANONICAL_STRING_H
#define CANONICAL_STRING_H
/***************************************************************************
 *   Copyright (C) 2007-2011 Mike Kinghan, imk@strudl.org                  *
 *   All rights reserved.                                                  *
 *                                                                         *
 *   Contributed originally by Mike Kinghan, imk@strudl.org                *
 *                                                                         *
 *   Redistribution and use in source and binary forms, with or without    *
 *   modification, are permitted provided that the following conditions    *
 *   are met:                                                              *
 *                                                                         *
 *   Redistributions of source code must retain the above copyright        *
 *   notice, this list of conditions and the following disclaimer.         *
 *                                                                         *
 *   Redistributions in binary form must reproduce the above copyright     *
 *   notice, this list of conditions and the following disclaimer in the   *
 *   documentation and/or other materials provided with the distribution.  *
 *                                                                         *
 *   Neither the name of Symbian Software Ltd. nor the names of its        *
 *   contributors may be used to endorse or promote products derived from  *
 *   this software without specific prior written permission.              *
 *                                                                         *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS   *
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT     *
 *   LIMITED TO, THE IMPLIED WARRANTIES OF  MERCHANTABILITY AND FITNESS    *
 *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE        *
 *   COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,   *
 *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,  *
 *   BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS *
 *   OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED    *
 *   AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,*
 *   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF *
 *   THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH  *
 *   DAMAGE.                                                               *
 *                                                                         *
 **************************************************************************/

#include "bool.h"
#include <stddef.h>


typedef struct canonical_string_impl * canonical_string_h;

typedef struct canonical_string_impl const * canonical_string_const_h;

extern canonical_string_h
canonical_string_new(char const *start, size_t nbytes, char const **pend);

struct int_spec; 
extern canonical_string_h
canonical_numeral(struct int_spec const * int_spec);

extern canonical_string_h
canonical_identifier(char const **cpp);


extern canonical_string_h
canonical_string_copy(canonical_string_const_h src);

extern void
canonical_string_dispose(canonical_string_h cs);

extern void
canonical_string_swap(canonical_string_h lhs, canonical_string_h rhs);

extern void
canonical_string_assign(canonical_string_h dest, canonical_string_const_h src);

extern bool
canonical_string_equal(canonical_string_const_h lhs, canonical_string_const_h rhs);

extern char const *
canonical_string_text(canonical_string_const_h cs);

extern size_t
canonical_string_length(canonical_string_const_h cs);


extern int
canonical_string_compare(canonical_string_const_h lhs,
                         void const *rhs, size_t rhslen);

extern void
canonical_string_appendc(canonical_string_h cs, char more);

extern void
canonical_string_appends(canonical_string_h cs, canonical_string_const_h more,
                        bool punct);

extern canonical_string_h
canonical_string_substr(canonical_string_const_h cs, size_t start, size_t len);

void
canonical_string_replace(canonical_string_h cs,
                        size_t start,
                        size_t len,
                        canonical_string_const_h subst);

#endif /* EOF */