gls_string.h

Go to the documentation of this file.

#ifndef _GLS_STRING_H
#define _GLS_STRING_H

/*! \file gls_string.h

\brief  This header defines the GlsString class
        in the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/

#include "gls_include.h"
#include "gls_types.h"
#include "gls_class_invariant.h"

/** This class is a simple fixed size string wrapper.
  * \invariant _charBuffer != GLS_NULL, _size <= MAX_STRING_SIZE,
  *            _length <= _size, _charBuffer[ _length ] == GLS_STRING_TERMINATOR
  */
class GlsString
{
public:
    GLS_CLASS_INVARIANT_DECLARATION( GlsString )

    /** maximum number of characters that can be stored ( not including NULL terminator */
    static const GlsUInt32 MAX_STRING_SIZE = ( GLSUINT32_MAX - 3u );

    /** Constructor - create an instance
      * \param size number of characters to hold (not including NULL terminator)
      * \pre size <= MAX_STRING_SIZE
      * \post instance created, string is set to empty string
      */
    GlsString( const GlsUInt32 size );

    /** Destructor - shall never be called
      * \pre none
      * \post none
      */
    virtual ~GlsString();

    /** Get a const pointer to the string
     * \return const char pointer to the string
     * \pre none 
     * \post none
     */
    const GlsChar* GetString( void ) const;

    /** Set string value
      * \param src new desired value for string ( src != GLS_NULL )
      * \pre src != GLS_NULL
      * \post string is equal to src if buffer is large enough to hold src,
      *       else is equal to src truncated to fit in buffer
      */
    void SetString( const GlsChar* const src );

    /** Get the length of the string 
      * \return length of string, number of characters before terminating NULL
      * \pre none
      * \post none
      */
    GlsUInt32 GetLength( void ) const;

protected:
    static const GlsChar STRING_TERMINATOR = '\0'; /**< string terminator (NULL character) */

    GlsChar* const   _charBuffer; /**< NULL terminated string, buffer size = _size + 1,
                                    * extra char for NULL terminator */
    const GlsUInt32  _size;       /**< number of characters that can be held in _charBuffer
                                    * not including NULL terminator */
    GlsUInt32        _length;     /**< length of string contained in char buffer
                                    * number of characters before terminating NULL */

private:
    // Disable implicit generated Members
    GlsString& operator=( const GlsString &rhs );
    GlsString( const GlsString &src );
};

#endif // _GLS_STRING_H