UtlNameValueTokenizer.h

Go to the documentation of this file.

//
// Copyright (C) 2007 SIPez LLC.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// Copyright (C) 2004-2007 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _UtlNameValueTokenizer_h_
#define _UtlNameValueTokenizer_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "utl/UtlString.h"

// DEFINES
#define NEWLINE '\n'
#define CARRIAGE_RETURN '\r'
#define CARRIAGE_RETURN_NEWLINE "\r\n"

// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class UtlNameValueTokenizer
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */

   UtlNameValueTokenizer(const char* multiLineText, int textLength = -1);

   virtual
   ~UtlNameValueTokenizer();

/* ============================ MANIPULATORS ============================== */

   static
   int findNextLineTerminator(const char* text, int length,
                              int* nextLineIndex);
   static
   UtlBoolean getSubField(const char* textField,
                          int subfieldIndex,
                          const char* subfieldSeparator,
                          UtlString* subfieldText,
                          int* lastCharIndex = NULL);

   static
   UtlBoolean getSubField(const char* textField,
                          int textFieldLength,
                          int subfieldIndex,
                          const char* subfieldSeparators,
                          const char*& subfieldPtr,
                          int& subFieldLength,
                          int* lastCharIndex);

   UtlBoolean getNextPair(char separator, UtlString* name, UtlString* value);

/* ============================ ACCESSORS ================================= */

/* ============================ INQUIRY =================================== */

    UtlBoolean isAtEnd();
    int getProcessedIndex();

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

    const char* textPtr;
    int textLen;
    int bytesConsumed;

    UtlNameValueTokenizer(const UtlNameValueTokenizer& rNameValueTokenizer);

    UtlNameValueTokenizer& operator=(const UtlNameValueTokenizer& rhs);
};

/* ============================ INLINE METHODS ============================ */

#endif  // _UtlNameValueTokenizer_h_