OpenClonk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
C4Reloc Class Reference

#include <C4Reloc.h>

Classes

struct  PathInfo
 

Public Types

enum  PathType { PATH_Regular, PATH_PreferredInstallationLocation }
 
typedef std::vector< PathInfoPathList
 
typedef PathList::const_iterator iterator
 

Public Member Functions

void Init ()
 
bool AddPath (const char *path, PathType pathType=PATH_Regular)
 
iterator begin () const
 
iterator end () const
 
bool Open (C4Group &hGroup, const char *filename) const
 
bool LocateItem (const char *filename, StdStrBuf &str) const
 

Detailed Description

Definition at line 19 of file C4Reloc.h.

Member Typedef Documentation

typedef PathList::const_iterator C4Reloc::iterator

Definition at line 36 of file C4Reloc.h.

typedef std::vector<PathInfo> C4Reloc::PathList

Definition at line 35 of file C4Reloc.h.

Member Enumeration Documentation

Enumerator
PATH_Regular 
PATH_PreferredInstallationLocation 

Definition at line 22 of file C4Reloc.h.

Member Function Documentation

bool C4Reloc::AddPath ( const char *  path,
PathType  pathType = PATH_Regular 
)

Definition at line 46 of file C4Reloc.cpp.

References IsGlobalPath().

Referenced by Init(), and C4Application::ParseCommandLine().

47 {
48  if(!IsGlobalPath(path))
49  return false;
50 
51  if(std::find(Paths.begin(), Paths.end(), path) != Paths.end())
52  return false;
53 
54  Paths.emplace_back(StdCopyStrBuf(path), pathType);
55  return true;
56 }
bool IsGlobalPath(const char *szPath)
Definition: StdFile.cpp:227

Here is the call graph for this function:

Here is the caller graph for this function:

C4Reloc::iterator C4Reloc::begin ( ) const

Definition at line 58 of file C4Reloc.cpp.

Referenced by C4Language::Init(), and C4AppDelegate::installAddOn.

59 {
60  return Paths.begin();
61 }

Here is the caller graph for this function:

C4Reloc::iterator C4Reloc::end ( ) const

Definition at line 63 of file C4Reloc.cpp.

Referenced by C4Language::Init(), and C4AppDelegate::installAddOn.

64 {
65  return Paths.end();
66 }

Here is the caller graph for this function:

void C4Reloc::Init ( )

Definition at line 23 of file C4Reloc.cpp.

References AddPath(), StdStrBuf::Append(), StdStrBuf::AppendBackslash(), Config, C4ConfigGeneral::ExePath, C4Config::General, StdStrBuf::getData(), PATH_PreferredInstallationLocation, C4ConfigGeneral::SystemDataPath, and C4ConfigGeneral::UserDataPath.

Referenced by C4Application::DoInit().

24 {
25  Paths.clear();
26 
27  // The system folder (i.e. installation path) has higher priority than the user path
28  // Although this is counter-intuitive (the user may want to overload system files in the user path),
29  // people had trouble when they downloaded e.g. an Objects.ocd file in a network lobby and that copy permanently
30  // ruined their OpenClonk installation with no obvious way to fix it.
31  // Not even reinstalling would fix the problem because reinstallation does not overwrite user data.
32  // We currently don't have any valid case where overloading system files would make sense so just give higher priority to the system path for now.
33 #ifndef __APPLE__
34  // Add planet subfolder with highest priority because it's used when starting directly from the repository with binaries in the root folder
36  planet.AppendBackslash();
37  planet.Append("planet");
38  AddPath(planet.getData());
39 #endif
40  // Add main system path
42  // Add user path for additional data (player files, user scenarios, etc.)
44 }
C4Config Config
Definition: C4Config.cpp:833
C4ConfigGeneral General
Definition: C4Config.h:251
char UserDataPath[CFG_MaxString+1]
Definition: C4Config.h:54
char SystemDataPath[CFG_MaxString+1]
Definition: C4Config.h:55
bool AddPath(const char *path, PathType pathType=PATH_Regular)
Definition: C4Reloc.cpp:46
StdCopyStrBuf ExePath
Definition: C4Config.h:52

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4Reloc::LocateItem ( const char *  filename,
StdStrBuf str 
) const

Definition at line 79 of file C4Reloc.cpp.

References StdStrBuf::Copy(), DirSep, StdStrBuf::getData(), IsGlobalPath(), and ItemExists().

Referenced by C4ControlJoinPlayer::C4ControlJoinPlayer(), and C4Network2Res::SetByFile().

80 {
81  if(IsGlobalPath(filename))
82  {
83  str.Copy(filename);
84  return true;
85  }
86 
87  for(const auto & iter : *this)
88  {
89  str.Copy(iter.strBuf + DirSep + filename);
90  if(ItemExists(str.getData()))
91  return true;
92  }
93 
94  return false;
95 }
const char * getData() const
Definition: StdBuf.h:442
bool IsGlobalPath(const char *szPath)
Definition: StdFile.cpp:227
#define DirSep
bool ItemExists(const char *szItemName)
Definition: StdFile.h:75
void Copy()
Definition: StdBuf.h:467

Here is the call graph for this function:

Here is the caller graph for this function:

bool C4Reloc::Open ( C4Group hGroup,
const char *  filename 
) const

Definition at line 68 of file C4Reloc.cpp.

References DirSep, IsGlobalPath(), and C4Group::Open().

Referenced by C4Application::DoInit(), C4LoaderScreen::Init(), C4SoundSystem::Init(), C4Game::InitMaterialTexture(), C4DefList::Load(), C4Player::Load(), C4PlayerInfo::LoadFromLocalFile(), C4Game::OpenScenario(), C4GraphicsResource::RegisterGlobalGraphics(), C4GroupSet::RegisterParentFolders(), and C4Network2Res::SetByFile().

69 {
70  if(IsGlobalPath(filename)) return hGroup.Open(filename);
71 
72  for(const auto & iter : *this)
73  if(hGroup.Open((iter.strBuf + DirSep + filename).getData()))
74  return true;
75 
76  return false;
77 }
bool IsGlobalPath(const char *szPath)
Definition: StdFile.cpp:227
bool Open(const char *szGroupName, bool fCreate=false)
Definition: C4Group.cpp:514
#define DirSep

Here is the call graph for this function:

Here is the caller graph for this function:


The documentation for this class was generated from the following files: