C4Reloc Class Reference

#include <C4Reloc.h>

Classes
class	const_iterator
struct	PathInfo

Public Types
enum	PathType { PATH_Regular , PATH_PreferredInstallationLocation , PATH_IncludingSubdirectories }
typedef std::vector< PathInfo >	PathList
typedef 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 &group, const char *filename) const
bool	LocateItem (const char *filename, StdStrBuf &str) const

Detailed Description

Definition at line 22 of file C4Reloc.h.

Member Typedef Documentation

iterator

typedef const_iterator C4Reloc::iterator

Definition at line 73 of file C4Reloc.h.

PathList

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

Definition at line 39 of file C4Reloc.h.

Member Enumeration Documentation

PathType

enum C4Reloc::PathType

Enumerator
PATH_Regular
PATH_PreferredInstallationLocation
PATH_IncludingSubdirectories

Definition at line 25 of file C4Reloc.h.

    {
        PATH_Regular,
        PATH_PreferredInstallationLocation,
        PATH_IncludingSubdirectories,
    };

Member Function Documentation

AddPath()

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

Definition at line 62 of file C4Reloc.cpp.

{
    if (!IsGlobalPath(path))
    {
        return false;
    }
 
    if (std::find(Paths.begin(), Paths.end(), path) != Paths.end())
    {
        return false;
    }
 
    Paths.emplace_back(StdCopyStrBuf(path), pathType);
    return true;
}

References IsGlobalPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

begin()

C4Reloc::iterator C4Reloc::begin

(

)

const

Definition at line 142 of file C4Reloc.cpp.

{
    C4Reloc::iterator iter;
    iter.pathListIter = Paths.begin();
    return std::move(iter);
}

References C4Reloc::const_iterator::pathListIter.

Referenced by C4Language::Init().

Here is the caller graph for this function:

end()

C4Reloc::iterator C4Reloc::end

(

)

const

Definition at line 149 of file C4Reloc.cpp.

{
    C4Reloc::iterator iter;
    iter.pathListIter = Paths.end();
    return std::move(iter);
}

References C4Reloc::const_iterator::pathListIter.

Referenced by C4Language::Init().

Here is the caller graph for this function:

Init()

void C4Reloc::Init

(

)

Definition at line 23 of file C4Reloc.cpp.

{
    Paths.clear();
 
    // The system folder (i.e. installation path) has higher priority than the user path
    // Although this is counter-intuitive (the user may want to overload system files in the user path),
    // people had trouble when they downloaded e.g. an Objects.ocd file in a network lobby and that copy permanently
    // ruined their OpenClonk installation with no obvious way to fix it.
    // Not even reinstalling would fix the problem because reinstallation does not overwrite user data.
    // 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.
#ifndef __APPLE__
    // Add planet subfolder with highest priority because it's used when starting directly from the repository with binaries in the root folder
    StdCopyStrBuf planet(Config.General.ExePath);
    planet.AppendBackslash();
    planet.Append("planet");
    if (DirectoryExists(planet.getData()))
    {
        // Only add planet if it's a valid contents folder.
        // Because users may create a folder "planet" in their source repos.
        StdCopyStrBuf planet_system_check(planet);
        planet_system_check.AppendBackslash();
        planet_system_check.Append(C4CFN_System);
        if (ItemExists(planet_system_check.getData()))
        {
            AddPath(planet.getData());
        }
    }
#endif
    // Add main system path (unless it's using planet/ anyway, in which we would just slow down scenario enumeration by looking throug hthe whole source folder)
    if (!Paths.size())
    {
        AddPath(Config.General.SystemDataPath);
    }
    // Add mods directory before the user path.
    AddPath(Config.General.ModsDataPath, PATH_IncludingSubdirectories);
    // Add user path for additional data (player files, user scenarios, etc.)
    AddPath(Config.General.UserDataPath, PATH_PreferredInstallationLocation);
}

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

Referenced by C4Application::DoInit().

Here is the call graph for this function:

Here is the caller graph for this function:

LocateItem()

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

Definition at line 174 of file C4Reloc.cpp.

{
    if (IsGlobalPath(filename))
    {
        str.Copy(filename);
        return true;
    }
 
    for(const auto & iter : *this)
    {
        str.Copy(iter.strBuf + DirSep + filename);
        if (ItemExists(str.getData()))
        {
            return true;
        }
    }
 
    return false;
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Open()

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

Definition at line 156 of file C4Reloc.cpp.

{
    if (IsGlobalPath(filename))
    {
        return group.Open(filename);
    }
 
    for (const auto & iter : *this)
    {
        if (group.Open((iter.strBuf + DirSep + filename).getData()))
        {
            return true;
        }
    }
 
    return false;
}

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

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

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:

• C4Reloc.h
• C4Reloc.cpp
• C4ScriptStandaloneStubs.cpp