lockfile.cpp File Reference

#include <build_version.h>
#include <lockfile.h>
#include <wx/filename.h>
#include <wx/snglinst.h>
#include <common.h>

Go to the source code of this file.

Functions
std::unique_ptr< wxSingleInstanceChecker >	LockFile (const wxString &aFileName)
	Test to see if aFileName can be locked (is not already locked) and only then returns a wxSingleInstanceChecker protecting aFileName. More...
wxString	GetKicadLockFilePath ()

Function Documentation

GetKicadLockFilePath()

wxString GetKicadLockFilePath

(

)

Returns

A wxString containing the path for lockfiles in Kicad.

Definition at line 60 of file lockfile.cpp.

{
    wxFileName lockpath;
    lockpath.AssignDir( wxGetHomeDir() ); // Default wx behavior

#if defined( __WXMAC__ )
    // In OSX use the standard per user cache directory
    lockpath.AppendDir( "Library" );
    lockpath.AppendDir( "Caches" );
    lockpath.AppendDir( "kicad" );
#elif defined( __UNIX__ )
    wxString envstr;
    // Try first the standard XDG_RUNTIME_DIR, falling back to XDG_CACHE_HOME
    if( wxGetEnv( "XDG_RUNTIME_DIR", &envstr ) && !envstr.IsEmpty() )
    {
        lockpath.AssignDir( envstr );
    }
    else if( wxGetEnv( "XDG_CACHE_HOME", &envstr ) && !envstr.IsEmpty() )
    {
        lockpath.AssignDir( envstr );
    }
    else
    {
        // If all fails, just use ~/.cache
        lockpath.AppendDir( ".cache" );
    }

    lockpath.AppendDir( wxString::Format( "kicad_v%s", GetMajorMinorVersion() ) );
#endif

#if defined( __WXMAC__ ) || defined( __UNIX__ )
    if( !lockpath.DirExists() )
    {
        // Lockfiles should be only readable by the user
        lockpath.Mkdir( 0700, wxPATH_MKDIR_FULL );
    }
#endif
    return lockpath.GetPath();
}

References Format(), and GetMajorMinorVersion().

Referenced by PGM_BASE::InitPgm(), and LockFile().

LockFile()

std::unique_ptr<wxSingleInstanceChecker> LockFile

(

const wxString &

aFileName

)

Test to see if aFileName can be locked (is not already locked) and only then returns a wxSingleInstanceChecker protecting aFileName.

Definition at line 33 of file lockfile.cpp.

{
    // first make absolute and normalize, to avoid that different lock files
    // for the same file can be created
    wxFileName fn( aFileName );

    fn.MakeAbsolute();

    wxString lockFileName = fn.GetFullPath() + ".lock";

    lockFileName.Replace( "/", "_" );

    // We can have filenames coming from Windows, so also convert Windows separator
    lockFileName.Replace( "\\", "_" );

    auto p = std::make_unique<wxSingleInstanceChecker>( lockFileName,
                                                        GetKicadLockFilePath() );

    if( p->IsAnotherRunning() )
    {
        p = nullptr;
    }

    return p;
}

References GetKicadLockFilePath().