/ray/src/lib/sourcepos/sourcefile.h

Go to the documentation of this file.

/*
 * lib/sourcepos/sourcefile.h
 * 
 * Classes for sophisticated source position (file/line/lpos, 
 * include hierarchy) handling. 
 * 
 * Copyright (c) 2003--2004 by Wolfgang Wieser ] wwieser (a) gmx <*> de [ 
 * 
 * This file may be distributed and/or modified under the terms of the 
 * GNU General Public License version 2 as published by the Free Software 
 * Foundation. (See COPYING.GPL for details.)
 * 
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 * 
 */

#ifndef _LIB_SOURCEPOS_SOURCEFILE_H_
#define _LIB_SOURCEPOS_SOURCEFILE_H_ 1

#include <lib/sconfig.h>    /* MUST be first */

#include <lib/tl/refnode.h>
#include <lib/tl/linkedlist.h>
#include <lib/tl/tlstring.h>

// As defined further down: 
class _InternalSourceFileNode;

typedef RefNode<_InternalSourceFileNode> SourceFileNode;

// As defined in sparchive.h. 
class SourcePositionArchive;

// As defined in spcache.h
class SourcePositionCache;


class _InternalSourceFileNode : 
    InternalRefNodeBase_ThreadSave,
    LinkedListBase<_InternalSourceFileNode>
{
    friend class SourcePositionArchive;
    friend class LinkedList<_InternalSourceFileNode>;
    friend class RefNode<_InternalSourceFileNode>;
    friend bool operator==(const SourceFileNode &a,const SourceFileNode &b);
    public:
        static SourceFileNode CreateSingleNode(const TLString &path);
    private:
        TLString _path;   
        
        SourcePositionArchive *pos_archive;
        
        _InternalSourceFileNode *up;
        LinkedList<_InternalSourceFileNode> down;
        
        int parent_include_line;
        int parent_include_lpos;
        
        filepos_t include_stmt_pos;
        size_t    include_stmt_len;
        
        SourcePositionCache *pos_cache;
        
        void _DestroyPosCache();
        
        inline void _DetachArchive()
            {  if(this) { pos_archive=NULL;  _DestroyPosCache(); }  }
        
        inline void _AddChild(_InternalSourceFileNode *isf)
            {  down.append(isf);  _InternalRefNodeBase_aqref();  }
        inline void _DelChild(_InternalSourceFileNode *isf)
            {  down.dequeue(isf);  _InternalRefNodeBase_deref();  }
        
        inline bool test_equal(const _InternalSourceFileNode &b) const
            {  return(this==&b);  }
        
        _InternalSourceFileNode(const _InternalSourceFileNode &);
        void operator=(const _InternalSourceFileNode &);
        
        _InternalSourceFileNode(const TLString &path,
            _InternalSourceFileNode *parent,
            SourcePositionArchive *pos_archive);
    public:
        ~_InternalSourceFileNode();
        
        inline SourcePositionArchive *archive() const
            {  return(this ? pos_archive : NULL);  }
        
        inline TLString path() const
            {  return(this ? _path : TLString());  }
        
        TLString IncludeHierarchyStr() const;
};

inline bool operator==(const SourceFileNode &a,const SourceFileNode &b)
    {  return((a && b) ? a->test_equal(*b) : (!a && !b));  }

inline bool operator!=(const SourceFileNode &a,const SourceFileNode &b)
    {  return(!operator==(a,b));  }


#endif  /* _LIB_SOURCEPOS_SOURCEFILE_H_ */

---