---

XSECSafeBuffer.hpp

Go to the documentation of this file.

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 Berin Lautenbach.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by
 *                   Berin Lautenbach"
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "XSEC", "xml-security-c" and Berin Lautenbach must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact berin@users.sourceforge.net.
 *
 * 5. Products derived from this software may not be called "xml-security-c",
 *    nor may "xml-security-c" appear in their name, without prior written
 *    permission of Berin Lautenbach.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 BERIN LAUTENBACH OR OTHER
 * 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.
 * ====================================================================
 */

/*
 * XSEC
 *
 * XSECSafeBuffer := a class for storing expanding amounts of information.
 *                   
 *
 */


#ifndef XSECSAFEBUFFER_INCLUDE
#define XSECSAFEBUFFER_INCLUDE

#include <xsec/framework/XSECDefs.hpp>
#include <xercesc/util/XMLString.hpp>

#define DEFAULT_SAFE_BUFFER_SIZE        1024        // Default size for a safe Buffer

class CANON_EXPORT safeBuffer {

private:

    unsigned char * buffer;
    unsigned int    bufferSize;
    XMLCh           * mp_XMLCh;

public:

    safeBuffer();
    safeBuffer(int initialSize);
    safeBuffer(char * inStr, unsigned int initialSize = DEFAULT_SAFE_BUFFER_SIZE);
    safeBuffer(const safeBuffer & other);

    ~safeBuffer();

    // "IN" functions - these read in information to the buffer

    void sbStrcpyIn(const char * inStr);
    void sbStrcpyIn(const safeBuffer & inStr);
    void sbStrncpyIn(char * inStr, int n);
    void sbStrncpyIn(const safeBuffer & inStr, int n);
    void sbStrcatIn(char * inStr);
    void sbStrcatIn(const safeBuffer & inStr);
    void sbStrncatIn(char * inStr, int n);
    void sbStrinsIn(const char * inStr, unsigned int offset);

    void sbMemcpyIn(void * inBuf, int n);
    void sbMemcpyIn(int offset, const void * inBuf, int n);

    void sbMemcpyOut(void * outBuf, int n) const;

    // Comparison functions

    int sbStrncmp(char * inStr, int n);
    int sbOffsetStrcmp(char * inStr, unsigned int offset);
    int sbOffsetStrncmp(char * inStr, unsigned int offset, int n);
    int sbStrcmp(char * inStr) const;
    int sbStrcmp(const safeBuffer & inStr) const;
    int sbStrstr(char * inStr);
    int sbOffsetStrstr(const char * inStr, unsigned int offset);


    // Operators

    unsigned char & operator[](int n);
    safeBuffer & operator= (const safeBuffer & cpy);

    // Get functions

    int sbStrlen(void) const;
    unsigned int sbRawBufferSize(void) const;

    // raw buffer manipulation

    const unsigned char * rawBuffer() const;
    const char * rawCharBuffer() const;
    void resize(unsigned int sz);           // NOTE : Only grows

    // Unicode
    const XMLCh * sbStrToXMLCh(void);


private:

    // Internal function that is used to get a string size and 
    // then re-allocate if necessary

    void checkAndExpand(unsigned int size);
};

#endif /* XSECSAFEBUFFER_INCLUDE */

---