haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/include/lockfile.h

49 lines
1.6 KiB
C
Raw Normal View History

Move file locking utilities to a separate file The global ::LockFile() function is used in a single place, but it's in common.h, so visible to all files. The GetKicadLockFilePath function is used in only two places, and one of them is LockFile. This commit puts them both in a separate header, so they're only visible to code using them. The implementation of GetKicadLockFilePath is moved to lockfile.cpp, where LockFile already was. Also removed a (large) handful of wxT macros, which aren't needed any more and make code less readable.
2017-02-09 08:09:28 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
Header clean up round 3.
2020-12-19 23:29:10 +00:00
* Copyright (C) 2017-2020 KiCad Developers, see AUTHORS.txt for contributors.
Move file locking utilities to a separate file The global ::LockFile() function is used in a single place, but it's in common.h, so visible to all files. The GetKicadLockFilePath function is used in only two places, and one of them is LockFile. This commit puts them both in a separate header, so they're only visible to code using them. The implementation of GetKicadLockFilePath is moved to lockfile.cpp, where LockFile already was. Also removed a (large) handful of wxT macros, which aren't needed any more and make code less readable.
2017-02-09 08:09:28 +00:00
*
* 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
Doxygen comment improvements. Fix lots of Doxygen warnings. Fix Doxygen comment for IO_MGR::FootprintEnumerate() which was recently changed.
2017-06-13 23:47:05 +00:00
* @file lockfile.h
Move file locking utilities to a separate file The global ::LockFile() function is used in a single place, but it's in common.h, so visible to all files. The GetKicadLockFilePath function is used in only two places, and one of them is LockFile. This commit puts them both in a separate header, so they're only visible to code using them. The implementation of GetKicadLockFilePath is moved to lockfile.cpp, where LockFile already was. Also removed a (large) handful of wxT macros, which aren't needed any more and make code less readable.
2017-02-09 08:09:28 +00:00
*/
#ifndef INCLUDE__LOCK_FILE_H_
#define INCLUDE__LOCK_FILE_H_
#include <wx/string.h>
#include <memory>
class wxSingleInstanceChecker;
/**
Header clean up round 3.
2020-12-19 23:29:10 +00:00
* Test to see if \a aFileName can be locked (is not already locked) and only then
Move file locking utilities to a separate file The global ::LockFile() function is used in a single place, but it's in common.h, so visible to all files. The GetKicadLockFilePath function is used in only two places, and one of them is LockFile. This commit puts them both in a separate header, so they're only visible to code using them. The implementation of GetKicadLockFilePath is moved to lockfile.cpp, where LockFile already was. Also removed a (large) handful of wxT macros, which aren't needed any more and make code less readable.
2017-02-09 08:09:28 +00:00
* returns a wxSingleInstanceChecker protecting aFileName.
*/
std::unique_ptr<wxSingleInstanceChecker> LockFile( const wxString& aFileName );
/**
Header clean up round 3.
2020-12-19 23:29:10 +00:00
* @return A wxString containing the path for lockfiles in Kicad.
Move file locking utilities to a separate file The global ::LockFile() function is used in a single place, but it's in common.h, so visible to all files. The GetKicadLockFilePath function is used in only two places, and one of them is LockFile. This commit puts them both in a separate header, so they're only visible to code using them. The implementation of GetKicadLockFilePath is moved to lockfile.cpp, where LockFile already was. Also removed a (large) handful of wxT macros, which aren't needed any more and make code less readable.
2017-02-09 08:09:28 +00:00
*/
wxString GetKicadLockFilePath();
#endif // INCLUDE__LOCK_FILE_H_