1 /* 2 * This program source code file is part of KiCad, a free EDA CAD application. 3 * 4 * Copyright (C) 2017-2020 KiCad Developers, see AUTHORS.txt for contributors. 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License 8 * as published by the Free Software Foundation; either version 2 9 * of the License, or (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, you may find one here: 18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html 19 * or you may search the http://www.gnu.org website for the version 2 license, 20 * or you may write to the Free Software Foundation, Inc., 21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA 22 */ 23 24 /** 25 * File locking utilities 26 * @file lockfile.h 27 */ 28 29 #ifndef INCLUDE__LOCK_FILE_H_ 30 #define INCLUDE__LOCK_FILE_H_ 31 32 #include <wx/string.h> 33 #include <memory> 34 35 class wxSingleInstanceChecker; 36 37 /** 38 * Test to see if \a aFileName can be locked (is not already locked) and only then 39 * returns a wxSingleInstanceChecker protecting aFileName. 40 */ 41 std::unique_ptr<wxSingleInstanceChecker> LockFile( const wxString& aFileName ); 42 43 /** 44 * @return A wxString containing the path for lockfiles in Kicad. 45 */ 46 wxString GetKicadLockFilePath(); 47 48 #endif // INCLUDE__LOCK_FILE_H_ 49