rvc/objitem.h

Go to the documentation of this file.

#ifndef  INC_RVC_OBJITEM_H
#define  INC_RVC_OBJITEM_H

#ifndef  INC_RVC_DESCRIPTOR_H
#include <rvc/descriptor.h>
#endif

#ifndef  INC_RVC_OBJTYPE_H
#include <rvc/objtype.h>
#endif

#ifndef  INC_MI32_FILEPATH_H
#include <mi32/filepath.h>
#endif

#ifndef  INC_MI32_FILEFIND_H
#include <mi32/filefind.h>
#endif

#ifndef  INC_MI32_ICONID_H
#include <mi32/iconid.h>
#endif

#ifdef RVCSYSDLL
   #define CLASSEXPORT MI_DLLCLASSEXPORT
#else
   #define CLASSEXPORT MI_DLLCLASSIMPORT
#endif

namespace RVC {
#ifndef GENERATING_DOXYGEN_OUTPUT
class CREDENTIALS;
class OBJECT;
class OBJITEMLIST;
class OBJMAKEPARMS;
class OBJOPENPARMS;
#endif // GENERATING_DOXYGEN_OUTPUT

//=====================================================================================================================

class CLASSEXPORT OBJITEM {
   public:

      enum TYPE {
         TYPE_Empty =            0,    
         TYPE_Invalid =          1,    
         TYPE_General_Folder =   2,    
         TYPE_General_File =     3,    
         TYPE_RVC_File =         4,    
         TYPE_RVC_Folder =       5,    
         TYPE_RVC_Object =       6,    
         TYPE_URL =              7,    
         };

      static ICONID GetIconIdFromObjectType (
         OBJTYPE objtype
         );

      static void SetupOutputList (
         OBJITEMLIST& oobjlist,           
         const OBJITEMLIST& iobjlist,     
         const char *source = 0           
         );

      OBJITEM (
         );

      OBJITEM (
         const OBJITEM& rhs               
         );

      OBJITEM (
         const FILEPATH& filename,        
         const MISTRING& ObjectPath       
         );

      OBJITEM (
         const MISTRING& URL,          
         const MISTRING& Title,           
         const RVC::OBJTYPE& ObjType         
         );

   #ifndef NO_DEPRECATED
      DEPRECATED OBJITEM (
         const FILEPATH& filename,           
         RVCINODENUM inode,                  
         const CREDENTIALS *pCredentials = 0
         );
   #endif

      OBJITEM (
         const DESCRIPTOR& Descriptor
         );

      ~OBJITEM (
         );

      OBJITEM operator= (
         const OBJITEM& rhs               
         );

      OBJITEM& operator= (
         const DESCRIPTOR& Descriptor
         );
         
      void Clear (
         );

      void CreateNew (
         const DESCRIPTOR& Descriptor,       
         RVC::OBJTYPE ObjType = RVC::OBJTYPE_All   
         );

      void CreateNew (
         const RVC::OBJITEM& ParentItem,     
         RVC::OBJTYPE ObjType,               
         const DESCRIPTOR& Descriptor        
         );

      void CreateNewFileNonRVC (
         const FILEPATH& filepath
         );

      ERRVALUE GetCombinedPath (
         MISTRING& CombinedPath,
         const CREDENTIALS *pCredentials = 0
         ) const;

      void GetDisplayPath (
         MISTRING& pathstr,
         const CREDENTIALS *pCredentials = 0
         ) const;

      void GetDisplayString (
         MISTRING& string,                   
         const CREDENTIALS *pCredentials = 0
         ) const;

      MISTRING GetDisplayString (
         const CREDENTIALS *pCredentials = 0
         ) const { MISTRING str; GetDisplayString(str, pCredentials); return (str); }

      const FILEPATH& GetFilePath (
         ) const { return (m_filename); }

      ICONID GetIconID (
         ) const;

   #ifndef NO_DEPRECATED
      DEPRECATED RVCINODENUM GetInode (
         const CREDENTIALS *pCredentials = 0
         ) const {
         if (!IsResolved()) ResolveObjectPath(pCredentials);
         return (m_ObjectInode);
         }
   #endif

      const DESCRIPTOR& GetObjectDescriptor (
         const CREDENTIALS *pCredentials = 0
         ) const { 
         if (!IsResolved()) ResolveObjectPath(pCredentials);
         return (m_Descriptor); 
         }

      void GetObjectDisplayPath (
         MISTRING& string,                   
         const CREDENTIALS *pCredentials = 0
         ) const;

      ERRVALUE GetObjectPath (
         MISTRING& ObjectPath,
         const CREDENTIALS *pCredentials = 0
         ) const {
         if (m_ObjectInode == -1) {
            ObjectPath = m_ObjectPath;
            return (0);
            }
         return (DetermineObjectPath(ObjectPath, pCredentials));
         }

      RVC::OBJTYPE GetObjectType (
         ) const;

      bool GetParent (
         OBJITEM& ParentObjItem,
         const CREDENTIALS *pCredentials = 0
         ) const;

   #if defined(RVCSYSDLL) && !defined(NO_DEPRECATED)
      DEPRECATED RVCINODENUM GetParentInode (
         const CREDENTIALS *pCredentials = 0
         ) const {
         if (!IsResolved()) ResolveObjectPath(pCredentials);
         return (m_ParentInode);
         }
   #endif

      const MISTRING& GetURL (
         ) const { 
         if (GetType() != TYPE_URL) return MISTRING::GetEmpty();
         return (m_ObjectPath);
         }

      void GetToolTipString (
         MISTRING& string,                
         const CREDENTIALS *pCredentials = 0
         ) const;

      const MISTRING& GetTitle (
         ) const { return (m_Title); }

      MISTRING GetToolTipString (
         const CREDENTIALS *pCredentials = 0
         ) const { MISTRING str; GetToolTipString(str, pCredentials); return (str); }

      OBJITEM::TYPE GetType (
         ) const;

      bool HasObjectDescription (
         const CREDENTIALS *pCredentials = 0
         ) const {
         if (!IsResolved()) ResolveObjectPath(pCredentials);
         return (!m_Descriptor.GetDescription().IsEmpty());
         }
         
      bool HasSameParent (
         const OBJITEM& rhs
         ) const { return (m_filename == rhs.m_filename && m_ParentInode == rhs.m_ParentInode); }

      bool IniRead (
         INIHANDLE handle,                   
         const char *group,                  
         const char *field                   
         );

      void IniWrite (
         INIHANDLE handle,                   
         const char *group,                  
         const char *field,                  
         const CREDENTIALS *pCredentials = 0
         ) const;

      bool IsAssigned (
         ) const;

      bool IsEqual (
         const OBJITEM& rhs,           
         const CREDENTIALS *pCredentials = 0
         ) const;

      bool IsExisting (
         const CREDENTIALS *pCredentials = 0
         ) const;

      bool IsFileNonRVC (
         ) const;

      bool IsFileOnly (
         ) const { return (!m_filename.IsEmpty() && (m_ObjectInode == 0 || m_ObjectInode == -2)); }

      bool IsLessThan (
         const OBJITEM& rhs
         ) const;
         
      bool IsLessThanChild (
         const OBJITEM& rhs
         ) const { return (m_ObjectInode < rhs.m_ObjectInode); }
         
      bool IsNewRequest (
         ) const { return (m_ObjectInode == R_NewRequest); }

      bool IsObjectExtFile (
         const CREDENTIALS *pCredentials = 0
         ) const;

      bool IsResolved (
         ) const;
         
      bool IsSkipRequest (
         ) const { return (m_ObjectInode == R_SkipRequest); }

      bool LocateRelated (
         const FILEPATH& SourcePath,               
         FILEFIND::RELATEDORDER order,             
         const CREDENTIALS *pCredentials = 0
         );

      void SetCombinedPath (
         const MISTRING& CombinedPath,
         const CREDENTIALS *pCredentials = 0
         ); 

      void SetFilePath (
         const FILEPATH& filepath
         );

      bool SetFromDisplayPath (
         const MISTRING& pathstr,
         const CREDENTIALS *pCredentials = 0
         );

      void SetItem (
         const FILEPATH& filename,        
         const MISTRING& ObjectPath       
         );

   #if defined(RVCSYSDLL) && !defined(NO_DEPRECATED)
      DEPRECATED void SetItem (
         const FILEPATH& filename,        
         RVCINODENUM inode,               
         const CREDENTIALS *pCredentials = 0
         );
   #endif

      void SetItemToFile (
         const FILEPATH& filename,        
         const CREDENTIALS *pCredentials = 0
         );

      void SetObjectDescriptor (
         const DESCRIPTOR& NewDescriptor
         );

      void SetObjectPath (
         const MISTRING& ObjectPath,         
         const CREDENTIALS *pCredentials = 0
         );

      void SetObjectType (
         OBJTYPE objtype                     
         ) { if (m_ObjectInode < 0) m_ObjType = objtype; }

      void SetSkipRequest ();

      void SetTitle (
         const MISTRING& title               
         ) { m_Title = title; }

      void SetURL (
         const MISTRING& url,                         
         RVC::OBJTYPE ObjType = RVC::OBJTYPE_Remote   
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      FILEPATH m_filename;                // File name
      mutable RVCINODENUM m_ObjectInode;
      mutable RVCINODENUM m_ParentInode;
      mutable OBJTYPE m_ObjType;
      MISTRING m_ObjectPath;              // Object path
      mutable DESCRIPTOR m_Descriptor;    // Object name, desc, and source
      MISTRING m_Title;                   // Object title

      // Determine object path from m_ginfo.
      ERRVALUE DetermineObjectPath (MISTRING& ObjectPath, const CREDENTIALS *pCredentials) const;

      // Resolve object path and setup m_ginfo.
      void ResolveObjectPath (const CREDENTIALS *pCredentials) const;

      friend class OBJECT;
      friend class OBJMAKEPARMS;
      friend class OBJOPENPARMS;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


inline bool operator== (
   const RVC::OBJITEM& lhs,            
   const RVC::OBJITEM& rhs             
   ) {
   return (lhs.IsEqual(rhs));
   }

inline bool operator!= (
   const RVC::OBJITEM& lhs,            
   const RVC::OBJITEM& rhs             
   ) {
   return (!lhs.IsEqual(rhs));
   }

inline bool operator< (                
   const RVC::OBJITEM& lhs,
   const RVC::OBJITEM& rhs
   ) { return (lhs.IsLessThan(rhs)); }
   
//=====================================================================================================================

}     // End namespace RVC

#undef CLASSEXPORT

#endif   // INC_RVC_OBJITEM_H

---