1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright The 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
*/
#include <wx/log.h>
#include <wx/stdpaths.h> // required on Mac
#include <kiplatform/environment.h>
#include <pgm_base.h>
#include <confirm.h>
#include <core/kicad_algo.h>
#include <design_block_lib_table.h>
#include <fp_lib_table.h>
#include <string_utils.h>
#include <kiface_ids.h>
#include <kiway.h>
#include <macros.h>
#include <project.h>
#include <project/project_file.h>
#include <trace_helpers.h>
#include <wildcards_and_files_ext.h>
#include <settings/common_settings.h>
#include <settings/settings_manager.h>
#include <title_block.h>
PROJECT::PROJECT() :
m_readOnly( false ),
m_textVarsTicker( 0 ),
m_netclassesTicker( 0 ),
m_projectFile( nullptr ),
m_localSettings( nullptr )
{
m_elems.fill( nullptr );
}
void PROJECT::ElemsClear()
{
// careful here, this should work, but the virtual destructor may not
// be in the same link image as PROJECT.
for( unsigned i = 0; i < m_elems.size(); ++i )
{
SetElem( static_cast<PROJECT::ELEM>( i ), nullptr );
}
}
PROJECT::~PROJECT()
{
ElemsClear();
}
bool PROJECT::TextVarResolver( wxString* aToken ) const
{
if( aToken->IsSameAs( wxT( "PROJECTNAME" ) ) )
{
*aToken = GetProjectName();
return true;
}
else if( aToken->IsSameAs( wxT( "CURRENT_DATE" ) ) )
{
*aToken = TITLE_BLOCK::GetCurrentDate();
return true;
}
else if( GetTextVars().count( *aToken ) > 0 )
{
*aToken = GetTextVars().at( *aToken );
return true;
}
return false;
}
std::map<wxString, wxString>& PROJECT::GetTextVars() const
{
return GetProjectFile().m_TextVars;
}
void PROJECT::ApplyTextVars( const std::map<wxString, wxString>& aVarsMap )
{
if( aVarsMap.size() == 0 )
return;
std::map<wxString, wxString>& existingVarsMap = GetTextVars();
for( const auto& var : aVarsMap )
{
// create or update the existing vars
existingVarsMap[var.first] = var.second;
}
}
void PROJECT::setProjectFullName( const wxString& aFullPathAndName )
{
// Compare paths, rather than inodes, to be less surprising to the user.
// Create a temporary wxFileName to normalize the path
wxFileName candidate_path( aFullPathAndName );
// Edge transitions only. This is what clears the project
// data using the Clear() function.
if( m_project_name.GetFullPath() != candidate_path.GetFullPath() )
{
Clear(); // clear the data when the project changes.
wxLogTrace( tracePathsAndFiles, "%s: old:'%s' new:'%s'", __func__,
TO_UTF8( GetProjectFullName() ), TO_UTF8( aFullPathAndName ) );
m_project_name = aFullPathAndName;
wxASSERT( m_project_name.IsAbsolute() );
wxASSERT( m_project_name.GetExt() == FILEEXT::ProjectFileExtension );
}
}
const wxString PROJECT::GetProjectFullName() const
{
return m_project_name.GetFullPath();
}
const wxString PROJECT::GetProjectPath() const
{
return m_project_name.GetPathWithSep();
}
const wxString PROJECT::GetProjectDirectory() const
{
return m_project_name.GetPath();
}
const wxString PROJECT::GetProjectName() const
{
return m_project_name.GetName();
}
bool PROJECT::IsNullProject() const
{
return m_project_name.GetName().IsEmpty();
}
const wxString PROJECT::SymbolLibTableName() const
{
return libTableName( FILEEXT::SymbolLibraryTableFileName );
}
const wxString PROJECT::FootprintLibTblName() const
{
return libTableName( FILEEXT::FootprintLibraryTableFileName );
}
const wxString PROJECT::DesignBlockLibTblName() const
{
return libTableName( FILEEXT::DesignBlockLibraryTableFileName );
}
void PROJECT::PinLibrary( const wxString& aLibrary, enum LIB_TYPE_T aLibType )
{
COMMON_SETTINGS* cfg = Pgm().GetCommonSettings();
std::vector<wxString>* pinnedLibsCfg = nullptr;
std::vector<wxString>* pinnedLibsFile = nullptr;
switch( aLibType )
{
case LIB_TYPE_T::SYMBOL_LIB:
pinnedLibsFile = &m_projectFile->m_PinnedSymbolLibs;
pinnedLibsCfg = &cfg->m_Session.pinned_symbol_libs;
break;
case LIB_TYPE_T::FOOTPRINT_LIB:
pinnedLibsFile = &m_projectFile->m_PinnedFootprintLibs;
pinnedLibsCfg = &cfg->m_Session.pinned_fp_libs;
break;
case LIB_TYPE_T::DESIGN_BLOCK_LIB:
pinnedLibsFile = &m_projectFile->m_PinnedDesignBlockLibs;
pinnedLibsCfg = &cfg->m_Session.pinned_design_block_libs;
break;
default:
wxFAIL_MSG( "Cannot pin library: invalid library type" );
return;
}
if( !alg::contains( *pinnedLibsFile, aLibrary ) )
pinnedLibsFile->push_back( aLibrary );
Pgm().GetSettingsManager().SaveProject();
if( !alg::contains( *pinnedLibsCfg, aLibrary ) )
pinnedLibsCfg->push_back( aLibrary );
cfg->SaveToFile( Pgm().GetSettingsManager().GetPathForSettingsFile( cfg ) );
}
void PROJECT::UnpinLibrary( const wxString& aLibrary, enum LIB_TYPE_T aLibType )
{
COMMON_SETTINGS* cfg = Pgm().GetCommonSettings();
std::vector<wxString>* pinnedLibsCfg = nullptr;
std::vector<wxString>* pinnedLibsFile = nullptr;
switch( aLibType )
{
case LIB_TYPE_T::SYMBOL_LIB:
pinnedLibsFile = &m_projectFile->m_PinnedSymbolLibs;
pinnedLibsCfg = &cfg->m_Session.pinned_symbol_libs;
break;
case LIB_TYPE_T::FOOTPRINT_LIB:
pinnedLibsFile = &m_projectFile->m_PinnedFootprintLibs;
pinnedLibsCfg = &cfg->m_Session.pinned_fp_libs;
break;
case LIB_TYPE_T::DESIGN_BLOCK_LIB:
pinnedLibsFile = &m_projectFile->m_PinnedDesignBlockLibs;
pinnedLibsCfg = &cfg->m_Session.pinned_design_block_libs;
break;
default:
wxFAIL_MSG( "Cannot unpin library: invalid library type" );
return;
}
alg::delete_matching( *pinnedLibsFile, aLibrary );
Pgm().GetSettingsManager().SaveProject();
alg::delete_matching( *pinnedLibsCfg, aLibrary );
cfg->SaveToFile( Pgm().GetSettingsManager().GetPathForSettingsFile( cfg ) );
}
const wxString PROJECT::libTableName( const wxString& aLibTableName ) const
{
wxFileName fn = GetProjectFullName();
wxString path = fn.GetPath();
// if there's no path to the project name, or the name as a whole is bogus or its not
// write-able then use a template file.
if( !fn.GetDirCount() || !fn.IsOk() || !wxFileName::IsDirWritable( path ) )
{
// return a template filename now.
// this next line is likely a problem now, since it relies on an
// application title which is no longer constant or known. This next line needs
// to be re-thought out.
#ifdef __WXMAC__
fn.AssignDir( KIPLATFORM::ENV::GetUserConfigPath() );
#else
// don't pollute home folder, temp folder seems to be more appropriate
fn.AssignDir( wxStandardPaths::Get().GetTempDir() );
#endif
#if defined( __WINDOWS__ )
fn.AppendDir( wxT( "kicad" ) );
#endif
/*
* The library table name used when no project file is passed to the appropriate
* code. This is used temporarily to store the project specific library table
* until the project file being edited is saved. It is then moved to the correct
* file in the folder where the project file is saved.
*/
fn.SetName( wxS( "prj-" ) + aLibTableName );
}
else // normal path.
{
fn.SetName( aLibTableName );
}
fn.ClearExt();
return fn.GetFullPath();
}
const wxString PROJECT::GetSheetName( const KIID& aSheetID )
{
if( m_sheetNames.empty() )
{
for( const std::pair<KIID, wxString>& pair : GetProjectFile().GetSheets() )
m_sheetNames[pair.first] = pair.second;
}
if( m_sheetNames.count( aSheetID ) )
return m_sheetNames.at( aSheetID );
else
return aSheetID.AsString();
}
void PROJECT::SetRString( RSTRING_T aIndex, const wxString& aString )
{
unsigned ndx = unsigned( aIndex );
if( ndx < m_rstrings.size() )
m_rstrings[ndx] = aString;
else
wxASSERT( 0 ); // bad index
}
const wxString& PROJECT::GetRString( RSTRING_T aIndex )
{
unsigned ndx = unsigned( aIndex );
if( ndx < m_rstrings.size() )
{
return m_rstrings[ndx];
}
else
{
static wxString no_cookie_for_you;
wxASSERT( 0 ); // bad index
return no_cookie_for_you;
}
}
PROJECT::_ELEM* PROJECT::GetElem( PROJECT::ELEM aIndex )
{
// This is virtual, so implement it out of line
if( static_cast<unsigned>( aIndex ) < m_elems.size() )
return m_elems[static_cast<unsigned>( aIndex )];
return nullptr;
}
void PROJECT::SetElem( PROJECT::ELEM aIndex, _ELEM* aElem )
{
// This is virtual, so implement it out of line
if( static_cast<unsigned>( aIndex ) < m_elems.size() )
{
delete m_elems[static_cast<unsigned>(aIndex)];
m_elems[static_cast<unsigned>( aIndex )] = aElem;
}
}
const wxString PROJECT::AbsolutePath( const wxString& aFileName ) const
{
wxFileName fn = aFileName;
// Paths which start with an unresolved variable reference are more likely to be
// absolute than relative.
if( aFileName.StartsWith( wxT( "${" ) ) )
return aFileName;
if( !fn.IsAbsolute() )
{
wxString pro_dir = wxPathOnly( GetProjectFullName() );
fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS, pro_dir );
}
return fn.GetFullPath();
}
FP_LIB_TABLE* PROJECT::PcbFootprintLibs( KIWAY& aKiway )
{
// This is a lazy loading function, it loads the project specific table when
// that table is asked for, not before.
FP_LIB_TABLE* tbl = (FP_LIB_TABLE*) GetElem( PROJECT::ELEM::FPTBL );
if( tbl )
{
wxASSERT( tbl->ProjectElementType() == PROJECT::ELEM::FPTBL );
}
else
{
try
{
// Build a new project specific FP_LIB_TABLE with the global table as a fallback.
// ~FP_LIB_TABLE() will not touch the fallback table, so multiple projects may
// stack this way, all using the same global fallback table.
KIFACE* kiface = aKiway.KiFACE( KIWAY::FACE_PCB );
tbl = (FP_LIB_TABLE*) kiface->IfaceOrAddress( KIFACE_NEW_FOOTPRINT_TABLE );
tbl->Load( FootprintLibTblName() );
SetElem( PROJECT::ELEM::FPTBL, tbl );
}
catch( const IO_ERROR& ioe )
{
DisplayErrorMessage( nullptr, _( "Error loading project footprint library table." ),
ioe.What() );
}
catch( ... )
{
DisplayErrorMessage( nullptr, _( "Error loading project footprint library table." ) );
}
}
return tbl;
}
DESIGN_BLOCK_LIB_TABLE* PROJECT::DesignBlockLibs()
{
// This is a lazy loading function, it loads the project specific table when
// that table is asked for, not before.
DESIGN_BLOCK_LIB_TABLE* tbl = (DESIGN_BLOCK_LIB_TABLE*) GetElem( ELEM::DESIGN_BLOCK_LIB_TABLE );
if( tbl )
{
wxASSERT( tbl->ProjectElementType() == PROJECT::ELEM::DESIGN_BLOCK_LIB_TABLE );
}
else
{
try
{
tbl = new DESIGN_BLOCK_LIB_TABLE( &DESIGN_BLOCK_LIB_TABLE::GetGlobalLibTable() );
tbl->Load( DesignBlockLibTblName() );
SetElem( ELEM::DESIGN_BLOCK_LIB_TABLE, tbl );
}
catch( const IO_ERROR& ioe )
{
DisplayErrorMessage( nullptr, _( "Error loading project design block library table." ),
ioe.What() );
}
catch( ... )
{
DisplayErrorMessage( nullptr,
_( "Error loading project design block library table." ) );
}
}
return tbl;
}
|