XObjectPath.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Base Library
 * Module     : XObjectPath
 * Package    : Zeus.ZeusBase.System
 * Author     : Benjamin Hadorn
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef XObjectPathH
#define XObjectPathH

#include <zeusbase/System/Interfaces/IXObject.hpp>
#include <zeusbase/System/ZObject.h>
#include <zeusbase/System/Queue.hpp>
#include <zeusbase/System/Stack.hpp>
#include <zeusbase/System/String.h>
#include <zeusbase/System/ZVariant.h>

BEGIN_NAMESPACE_Zeus

class TXObjectCollection;

/******************************************************************************/
/******************************************************************************/
class TXObjectPath : public TZObject
{
  public:
    TXObjectPath(IXObject* pObj);
    virtual ~TXObjectPath();

    Retval getObject(const IString& rPath, IXObject*& rpObject);
    Retval getObjects(const IString& rPath, IXObjectCollection*& pObjects);

  protected:

  private:
    IXObject* m_pObject;
    Int m_iCounter;
    wchar_t* m_wcBuffer;

    Retval findSingleObject(IXObject** ppObject);
    void startScanner(const IString& path);
    void clearBuffer();

  public:
    enum ETokenValue
    {
      etValueEnd = '\0',
      etValuePoint = '.',
      etValueSeperator = '/',
      etValueOpenBracket = '[',
      etValueCloseBracket = ']',
      etValueEquals = '=',
      etValueAttribute = '@',
      etValueSmi = '\''
    };


    enum ETokenType
    {
      etTokenUnknown,   
      etTokenRoot,      
      etTokenParent,    
      etTokenRecursive, 
      etTokenObject     
    };

  protected:

    /*************************************************************************/
    /*************************************************************************/
    struct TypeToken
    {
      ETokenType Type;
      TString strName;

      inline TypeToken()
      {
        Type = etTokenUnknown;
      }

      inline TypeToken(ETokenType type)
      {
        Type = type;
      }

      inline TypeToken(ETokenType type, const TString& name)
      {
        Type = type;
        strName = name;
      }

      inline bool operator==(const TypeToken& inpar) const
      {
        return (Type    == inpar.Type &&
                strName == inpar.strName);
      }

    };

    TQueue<TypeToken> m_lstTokens;

    Retval findObject(IXObject& rBaseObject, IXObject*& rpResult);
    Retval findObjects2(IXObject& rBaseObject, TStack<TypeToken>& rTokens, TXObjectCollection& rResults);

};


END_NAMESPACE_Zeus

#endif