51 lines
1.6 KiB
C++
51 lines
1.6 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2017 KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
/**
|
|
* File locking utilities
|
|
* @file lock_file.h
|
|
*/
|
|
|
|
#ifndef INCLUDE__LOCK_FILE_H_
|
|
#define INCLUDE__LOCK_FILE_H_
|
|
|
|
#include <wx/string.h>
|
|
#include <memory>
|
|
|
|
class wxSingleInstanceChecker;
|
|
|
|
/**
|
|
* Function LockFile
|
|
* tests to see if aFileName can be locked (is not already locked) and only then
|
|
* returns a wxSingleInstanceChecker protecting aFileName.
|
|
*/
|
|
std::unique_ptr<wxSingleInstanceChecker> LockFile( const wxString& aFileName );
|
|
|
|
/**
|
|
* Function GetKicadLockFilePath
|
|
* @return A wxString containing the path for lockfiles in Kicad
|
|
*/
|
|
wxString GetKicadLockFilePath();
|
|
|
|
#endif // INCLUDE__LOCK_FILE_H_
|