oaString.h

Go to the documentation of this file.

// *****************************************************************************
// oaString.h
//
// This file contains the definition for the oaString class. This utility class
// provides type safty and operators for character arrays.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaString_P)
#define oaString_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaBaseTypes.h"
#include <stdarg.h>



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************

BEGIN_OA_NAMESPACE



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaString;



// *****************************************************************************
// Function Declarations
// *****************************************************************************
OA_BASE_DLL_API oaString operator+(const oaString   &s1,
                                   const oaString   &s2);
OA_BASE_DLL_API oaBoolean operator<(const oaString  &s1,
                                    const oaChar    *s2);
OA_BASE_DLL_API oaBoolean operator<(const oaChar    *s1,
                                    const oaString  &s2);
OA_BASE_DLL_API oaBoolean operator>(const oaString  &s1,
                                    const oaChar    *s2);
OA_BASE_DLL_API oaBoolean operator>(const oaChar    *s1,
                                    const oaString  &s2);
OA_BASE_DLL_API oaBoolean operator==(const oaString &s1,
                                     const oaChar   *s2);
OA_BASE_DLL_API oaBoolean operator==(const oaChar   *s1,
                                     const oaString &s2);
OA_BASE_DLL_API oaBoolean operator<=(const oaString &s1,
                                     const oaChar   *s2);
OA_BASE_DLL_API oaBoolean operator<=(const oaChar   *s1,
                                     const oaString &s2);
OA_BASE_DLL_API oaBoolean operator>=(const oaString &s1,
                                     const oaChar   *s2);
OA_BASE_DLL_API oaBoolean operator>=(const oaChar   *s1,
                                     const oaString &s2);
OA_BASE_DLL_API oaBoolean operator!=(const oaString &s1,
                                     const oaChar   *s2);
OA_BASE_DLL_API oaBoolean operator!=(const oaChar   *s1,
                                     const oaString &s2);



// *****************************************************************************
// oaString
// *****************************************************************************
class OA_BASE_DLL_API oaString {
public:
                                        oaString();
    explicit                            oaString(oaUInt4 length);
                                        oaString(const oaChar *initialValue);
                                        oaString(const oaChar   *initialValue,
                                                 oaUInt4        length);
                                        oaString(const oaString &s);
                                        ~oaString();

    oaString                            &operator=(oaChar c);
    oaString                            &operator=(const oaChar *str);
    oaString                            &operator=(const oaString &str);
    oaString                            &operator+=(oaChar c);
    oaString                            &operator+=(const oaChar *str);
    oaString                            &operator+=(const oaString &str);
    oaBoolean                           operator<(const oaString &str) const;
    oaBoolean                           operator>(const oaString &str) const;
    oaBoolean                           operator==(const oaString &str) const;
    oaBoolean                           operator<=(const oaString &str) const;
    oaBoolean                           operator>=(const oaString &str) const;
    oaBoolean                           operator!=(const oaString &str) const;

                                        operator const      oaChar*() const;

    oaUInt4                             getLength() const;
    oaBoolean                           isEmpty() const;

    oaDouble                            toDouble() const;
    int                                 toInt() const;

    void                                toUpper();
    void                                toLower();

    void                                resize(oaUInt4 size);
    oaUInt4                             getSize() const;

    char                                &operator[](oaUInt4 i);
    const oaChar                        &operator[](oaUInt4 i) const;

    oaUInt4                             index(oaChar    c,
                                              oaUInt4   offset = 0) const;
    oaUInt4                             substr(const oaString   &sub,
                                               oaUInt4          offset = 0) const;

    oaBoolean                           isEqual(const oaString  &str,
                                                oaBoolean       ignoreCase) const;

    void                                format(oaUInt4      size,
                                               const oaChar *formatStr,
                                               ...);
    void                                format(const oaChar *formatStr,
                                               ...);
    void                                format(const oaChar *formatStr,
                                               va_list      args);

private:
    oaUInt4                             size;
    oaChar                              *data;

    friend OA_BASE_DLL_API oaString     operator+(const oaString    &s1,
                                                  const oaString    &s2);
    friend OA_BASE_DLL_API oaBoolean    operator<(const oaString    &s1,
                                                  const oaChar      *s2);
    friend OA_BASE_DLL_API oaBoolean    operator<(const oaChar      *s1,
                                                  const oaString    &s2);
    friend OA_BASE_DLL_API oaBoolean    operator>(const oaString    &s1,
                                                  const oaChar      *s2);
    friend OA_BASE_DLL_API oaBoolean    operator>(const oaChar      *s1,
                                                  const oaString    &s2);
    friend OA_BASE_DLL_API oaBoolean    operator==(const oaString   &s1,
                                                   const oaChar     *s2);
    friend OA_BASE_DLL_API oaBoolean    operator==(const oaChar     *s1,
                                                   const oaString   &s2);
    friend OA_BASE_DLL_API oaBoolean    operator<=(const oaString   &s1,
                                                   const oaChar     *s2);
    friend OA_BASE_DLL_API oaBoolean    operator<=(const oaChar     *s1,
                                                   const oaString   &s2);
    friend OA_BASE_DLL_API oaBoolean    operator>=(const oaString   &s1,
                                                   const oaChar     *s2);
    friend OA_BASE_DLL_API oaBoolean    operator>=(const oaChar     *s1,
                                                   const oaString   &s2);
    friend OA_BASE_DLL_API oaBoolean    operator!=(const oaString   &s1,
                                                   const oaChar     *s2);
    friend OA_BASE_DLL_API oaBoolean    operator!=(const oaChar     *s1,
                                                   const oaString   &s2);
};



END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.