kicad/common/common.cpp

569 lines
15 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 2008-2011 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2011 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 common.cpp
*/
#include <fctsys.h>
#include <gr_basic.h>
#include <trigo.h>
#include <wxstruct.h>
#include <base_struct.h>
#include <common.h>
#include <macros.h>
#include <build_version.h>
#include <confirm.h>
2008-04-24 16:55:35 +00:00
#include <wx/process.h>
2008-01-05 17:20:46 +00:00
/**
* Global variables definitions.
*
* TODO: All if these variables should be moved into the class were they
* are defined and used. Most of them probably belong in the
* application class.
*/
const wxString ProjectFileExtension( wxT( "pro" ) );
const wxString SchematicFileExtension( wxT( "sch" ) );
const wxString NetlistFileExtension( wxT( "net" ) );
const wxString GerberFileExtension( wxT( "pho" ) );
const wxString PcbFileExtension( wxT( "brd" ) );
const wxString PdfFileExtension( wxT( "pdf" ) );
const wxString MacrosFileExtension( wxT( "mcr" ) );
const wxString ProjectFileWildcard( _( "KiCad project files (*.pro)|*.pro" ) );
const wxString SchematicFileWildcard( _( "KiCad schematic files (*.sch)|*.sch" ) );
const wxString NetlistFileWildcard( _( "KiCad netlist files (*.net)|*.net" ) );
const wxString GerberFileWildcard( _( "Gerber files (*.pho)|*.pho" ) );
const wxString PcbFileWildcard( _( "KiCad printed circuit board files (*.brd)|*.brd" ) );
const wxString PdfFileWildcard( _( "Portable document format files (*.pdf)|*.pdf" ) );
const wxString MacrosFileWildcard( _( "KiCad recorded macros (*.mcr)|*.mcr" ) );
2009-06-13 17:06:07 +00:00
const wxString AllFilesWildcard( _( "All files (*)|*" ) );
2009-06-13 17:06:07 +00:00
wxString g_ProductName = wxT( "KiCad E.D.A. " );
bool g_ShowPageLimits = true;
wxString g_UserLibDirBuffer;
2009-06-13 17:06:07 +00:00
wxString g_Prj_Default_Config_FullFilename;
wxString g_Prj_Config_LocalFilename;
EDA_UNITS_T g_UserUnit;
2009-06-13 17:06:07 +00:00
int g_GhostColor;
/**
* The predefined colors used in KiCad.
* Please: if you change a value, remember these values are carefully chosen
* to have good results in Pcbnew, that uses the ORed value of basic colors
* when displaying superimposed objects
* This list must have exactly NBCOLOR items
*/
StructColors ColorRefs[NBCOLOR] =
{
2009-06-13 17:06:07 +00:00
{ 0, 0, 0, BLACK, wxT( "BLACK" ), DARKDARKGRAY },
{ 192, 0, 0, BLUE, wxT( "BLUE" ), LIGHTBLUE },
{ 0, 160, 0, GREEN, wxT( "GREEN" ), LIGHTGREEN },
{ 160, 160, 0, CYAN, wxT( "CYAN" ), LIGHTCYAN },
{ 0, 0, 160, RED, wxT( "RED" ), LIGHTRED },
{ 160, 0, 160, MAGENTA, wxT( "MAGENTA" ), LIGHTMAGENTA },
{ 0, 128, 128, BROWN, wxT( "BROWN" ), YELLOW },
{ 192, 192, 192, LIGHTGRAY, wxT( "GRAY" ), WHITE },
{ 128, 128, 128, DARKGRAY, wxT( "DARKGRAY" ), LIGHTGRAY },
{ 255, 0, 0, LIGHTBLUE, wxT( "LIGHTBLUE" ), LIGHTBLUE },
{ 0, 255, 0, LIGHTGREEN, wxT( "LIGHTGREEN" ), LIGHTGREEN },
{ 255, 255, 0, LIGHTCYAN, wxT( "LIGHTCYAN" ), LIGHTCYAN },
{ 0, 0, 255, LIGHTRED, wxT( "LIGHTRED" ), LIGHTRED },
{ 255, 0, 255, LIGHTMAGENTA, wxT( "LIGHTMAGENTA" ), LIGHTMAGENTA },
{ 0, 255, 255, YELLOW, wxT( "YELLOW" ), YELLOW },
{ 255, 255, 255, WHITE, wxT( "WHITE" ), WHITE },
{ 64, 64, 64, DARKDARKGRAY, wxT( "DARKDARKGRAY" ), DARKGRAY },
{ 64, 0, 0, DARKBLUE, wxT( "DARKBLUE" ), BLUE },
{ 0, 64, 0, DARKGREEN, wxT( "DARKGREEN" ), GREEN },
{ 64, 64, 0, DARKCYAN, wxT( "DARKCYAN" ), CYAN },
{ 0, 0, 80, DARKRED, wxT( "DARKRED" ), RED },
{ 64, 0, 64, DARKMAGENTA, wxT( "DARKMAGENTA" ), MAGENTA },
{ 0, 64, 64, DARKBROWN, wxT( "DARKBROWN" ), BROWN },
{ 128, 255, 255, LIGHTYELLOW, wxT( "LIGHTYELLOW" ), LIGHTYELLOW }
};
/**
* Function to use local notation or C standard notation for floating point numbers
* some countries use 1,5 and others (and C) 1.5
* so we switch from local to C and C to local when reading or writing files
* And other problem is a bug when cross compiling under linux:
* a printf print 1,5 and the read functions expects 1.5
* (depending on version print = 1.5 and read = 1,5
* Very annoying and we detect this and use a stupid but necessary workarount
*/
bool g_DisableFloatingPointLocalNotation = false;
2007-08-22 05:11:01 +00:00
void SetLocaleTo_C_standard( void )
2008-06-06 16:39:45 +00:00
{
setlocale( LC_NUMERIC, "C" ); // Switch the locale to standard C
}
2008-09-09 11:32:21 +00:00
void SetLocaleTo_Default( void )
2008-06-06 16:39:45 +00:00
{
if( ! g_DisableFloatingPointLocalNotation )
setlocale( LC_NUMERIC, "" ); // revert to the current locale
2008-06-06 16:39:45 +00:00
}
2008-09-09 11:32:21 +00:00
bool EnsureTextCtrlWidth( wxTextCtrl* aCtrl, const wxString* aString )
{
2009-06-13 17:06:07 +00:00
wxWindow* window = aCtrl->GetParent();
if( !window )
window = aCtrl;
2009-06-13 17:06:07 +00:00
wxString ctrlText;
if( !aString )
{
ctrlText = aCtrl->GetValue();
2009-06-13 17:06:07 +00:00
aString = &ctrlText;
}
2009-06-13 17:06:07 +00:00
wxCoord width;
wxCoord height;
{
wxClientDC dc( window );
dc.SetFont( aCtrl->GetFont() );
dc.GetTextExtent( *aString, &width, &height );
}
wxSize size = aCtrl->GetSize();
if( size.GetWidth() < width + 10 )
{
size.SetWidth( width + 10 );
aCtrl->SetSizeHints( size );
return true;
}
return false;
}
wxString ReturnUnitSymbol( EDA_UNITS_T aUnit, const wxString& formatString )
{
wxString tmp;
2007-08-22 05:11:01 +00:00
wxString label;
switch( aUnit )
2007-08-22 05:11:01 +00:00
{
case INCHES:
tmp = _( "\"" );
2007-08-22 05:11:01 +00:00
break;
case MILLIMETRES:
tmp = _( "mm" );
2007-08-22 05:11:01 +00:00
break;
case UNSCALED_UNITS:
2007-08-22 05:11:01 +00:00
break;
}
if( formatString.IsEmpty() )
return tmp;
label.Printf( formatString, GetChars( tmp ) );
2007-08-22 05:11:01 +00:00
return label;
}
2007-08-22 05:11:01 +00:00
wxString GetUnitsLabel( EDA_UNITS_T aUnit )
{
wxString label;
switch( aUnit )
{
case INCHES:
label = _( "inches" );
break;
case MILLIMETRES:
label = _( "millimeters" );
break;
case UNSCALED_UNITS:
label = _( "units" );
break;
}
return label;
}
wxString GetAbbreviatedUnitsLabel( EDA_UNITS_T aUnit )
{
wxString label;
switch( aUnit )
{
case INCHES:
label = _( "in" );
break;
case MILLIMETRES:
label = _( "mm" );
break;
case UNSCALED_UNITS:
break;
}
return label;
}
void AddUnitSymbol( wxStaticText& Stext, EDA_UNITS_T aUnit )
{
2009-08-11 10:27:21 +00:00
wxString msg = Stext.GetLabel();
msg += ReturnUnitSymbol( aUnit );
2007-08-22 05:11:01 +00:00
Stext.SetLabel( msg );
}
2007-08-22 05:11:01 +00:00
void PutValueInLocalUnits( wxTextCtrl& TextCtr, int Value, int Internal_Unit )
{
wxString msg = ReturnStringFromValue( g_UserUnit, Value, Internal_Unit );
2007-08-22 05:11:01 +00:00
TextCtr.SetValue( msg );
}
2007-08-22 05:11:01 +00:00
int ReturnValueFromTextCtrl( const wxTextCtrl& TextCtr, int Internal_Unit )
{
2007-08-22 05:11:01 +00:00
int value;
wxString msg = TextCtr.GetValue();
value = ReturnValueFromString( g_UserUnit, msg, Internal_Unit );
2007-08-22 05:11:01 +00:00
return value;
}
2007-08-22 05:11:01 +00:00
wxString ReturnStringFromValue( EDA_UNITS_T aUnit, int aValue, int aInternal_Unit,
bool aAdd_unit_symbol )
{
2007-08-22 05:11:01 +00:00
wxString StringValue;
double value_to_print;
value_to_print = To_User_Unit( aUnit, aValue, aInternal_Unit );
/* Yet another 'if Pcbnew' :( */
StringValue.Printf( ( aInternal_Unit > 1000 ) ? wxT( "%.4f" ) : wxT( "%.3f" ),
value_to_print );
2007-08-22 05:11:01 +00:00
2008-09-09 11:32:21 +00:00
if( aAdd_unit_symbol )
switch( aUnit )
2008-09-09 11:32:21 +00:00
{
case INCHES:
StringValue += _( " \"" );
break;
case MILLIMETRES:
2008-09-09 11:32:21 +00:00
StringValue += _( " mm" );
break;
case UNSCALED_UNITS:
2008-09-09 11:32:21 +00:00
break;
}
2007-08-22 05:11:01 +00:00
return StringValue;
}
2007-08-22 05:11:01 +00:00
int ReturnValueFromString( EDA_UNITS_T aUnit, const wxString& TextValue, int Internal_Unit )
{
2007-08-22 05:11:01 +00:00
int Value;
double dtmp = 0;
/* Acquire the 'right' decimal point separator */
const struct lconv* lc = localeconv();
wxChar decimal_point = lc->decimal_point[0];
wxString buf( TextValue.Strip( wxString::both ) );
/* Convert the period in decimal point */
buf.Replace( wxT( "." ), wxString( decimal_point, 1 ) );
// An ugly fix needed by WxWidgets 2.9.1 that sometimes
// back to a point as separator, although the separator is the comma
// TODO: remove this line if WxWidgets 2.9.2 fixes this issue
buf.Replace( wxT( "," ), wxString( decimal_point, 1 ) );
/* Find the end of the numeric part */
unsigned brk_point = 0;
while( brk_point < buf.Len() )
{
wxChar ch = buf[brk_point];
if( !( (ch >= '0' && ch <='9') || (ch == decimal_point) || (ch == '-') || (ch == '+') ) )
{
break;
}
++brk_point;
}
/* Extract the numeric part */
buf.Left( brk_point ).ToDouble( &dtmp );
/* Check the optional unit designator (2 ch significant) */
wxString unit( buf.Mid( brk_point ).Strip( wxString::leading ).Left( 2 ).Lower() );
if( unit == wxT( "in" ) || unit == wxT( "\"" ) )
{
aUnit = INCHES;
}
else if( unit == wxT( "mm" ) )
{
aUnit = MILLIMETRES;
}
else if( unit == wxT( "mi" ) || unit == wxT( "th" ) ) /* Mils or thous */
{
aUnit = INCHES;
dtmp /= 1000;
}
Value = From_User_Unit( aUnit, dtmp, Internal_Unit );
2007-08-22 05:11:01 +00:00
return Value;
}
2007-08-22 05:11:01 +00:00
2009-06-13 17:06:07 +00:00
wxArrayString* wxStringSplit( wxString aString, wxChar aSplitter )
{
wxArrayString* list = new wxArrayString();
2009-06-13 17:06:07 +00:00
while( 1 )
{
int index = aString.Find( aSplitter );
2009-06-13 17:06:07 +00:00
if( index == wxNOT_FOUND )
break;
2009-05-02 07:35:04 +00:00
2009-06-13 17:06:07 +00:00
wxString tmp;
tmp = aString.Mid( 0, index );
aString = aString.Mid( index + 1, aString.size() - index );
2009-06-13 17:06:07 +00:00
list->Add( tmp );
}
2009-05-02 07:35:04 +00:00
if( !aString.IsEmpty() )
{
list->Add( aString );
}
2009-05-02 07:35:04 +00:00
return list;
}
2007-08-22 05:11:01 +00:00
/**
* Function To_User_Unit
* Convert in inch or mm the variable "val" (double)given in internal units
* @return the converted value, in double
* @param aUnit : user measure unit
* @param val : double : the given value
* @param internal_unit_value = internal units per inch
*/
double To_User_Unit( EDA_UNITS_T aUnit, double val, int internal_unit_value )
{
switch( aUnit )
{
case MILLIMETRES:
return val * 25.4 / internal_unit_value;
case INCHES:
return val / internal_unit_value;
default:
return val;
}
}
/*
* Return in internal units the value "val" given in inch or mm
*/
int From_User_Unit( EDA_UNITS_T aUnit, double val, int internal_unit_value )
{
2007-08-22 05:11:01 +00:00
double value;
switch( aUnit )
{
case MILLIMETRES:
2010-03-26 19:34:47 +00:00
value = val * internal_unit_value / 25.4;
break;
case INCHES:
2007-08-22 05:11:01 +00:00
value = val * internal_unit_value;
break;
default:
case UNSCALED_UNITS:
value = val;
}
return wxRound( value );
}
2007-08-22 05:11:01 +00:00
/*
* Return the string date "day month year" like "23 jun 2005"
*/
wxString GenDate()
{
2007-08-22 05:11:01 +00:00
static const wxString mois[12] =
{
wxT( "jan" ), wxT( "feb" ), wxT( "mar" ), wxT( "apr" ), wxT( "may" ), wxT( "jun" ),
wxT( "jul" ), wxT( "aug" ), wxT( "sep" ), wxT( "oct" ), wxT( "nov" ), wxT( "dec" )
};
2008-04-24 16:55:35 +00:00
2008-09-09 11:32:21 +00:00
time_t buftime;
struct tm* Date;
wxString string_date;
2007-08-22 05:11:01 +00:00
time( &buftime );
2007-08-22 05:11:01 +00:00
Date = gmtime( &buftime );
string_date.Printf( wxT( "%d %s %d" ), Date->tm_mday,
GetChars( mois[Date->tm_mon] ),
2009-06-13 17:06:07 +00:00
Date->tm_year + 1900 );
2007-08-22 05:11:01 +00:00
return string_date;
}
2007-08-22 05:11:01 +00:00
bool ProcessExecute( const wxString& aCommandLine, int aFlags )
2008-04-24 16:55:35 +00:00
{
#ifdef __WINDOWS__
2008-09-09 11:32:21 +00:00
int pid = wxExecute( aCommandLine );
2008-06-29 18:51:38 +00:00
return pid ? true : false;
#else
2008-09-09 11:32:21 +00:00
wxProcess* process = wxProcess::Open( aCommandLine, aFlags );
2008-06-29 18:51:38 +00:00
return (process != NULL) ? true : false;
#endif
2008-04-24 16:55:35 +00:00
}
unsigned long GetNewTimeStamp()
{
static unsigned long oldTimeStamp;
unsigned long newTimeStamp;
newTimeStamp = time( NULL );
if( newTimeStamp <= oldTimeStamp )
newTimeStamp = oldTimeStamp + 1;
oldTimeStamp = newTimeStamp;
return newTimeStamp;
}
2007-08-22 05:11:01 +00:00
const wxString& valeur_param( int valeur, wxString& buf_texte )
{
switch( g_UserUnit )
2007-08-22 05:11:01 +00:00
{
case MILLIMETRES:
buf_texte.Printf( _( "%3.3f mm" ), valeur * 0.00254 );
break;
case INCHES:
2007-10-11 00:11:59 +00:00
buf_texte.Printf( wxT( "%2.4f \"" ), valeur * 0.0001 );
break;
case UNSCALED_UNITS:
buf_texte.Printf( wxT( "%d" ), valeur );
break;
2007-08-22 05:11:01 +00:00
}
2008-02-19 00:35:45 +00:00
2007-10-13 06:18:44 +00:00
return buf_texte;
}
2008-05-05 19:43:56 +00:00
wxString CoordinateToString( int aValue, int aInternalUnits, bool aConvertToMils )
{
wxCHECK_MSG( (aInternalUnits == EESCHEMA_INTERNAL_UNIT)
|| (aInternalUnits == PCB_INTERNAL_UNIT),
wxString( _( "*** Bad Internal Units ***" ) ),
wxT( "Invalid interanl units value." ) );
wxString text;
const wxChar* format;
double value = To_User_Unit( g_UserUnit, aValue, aInternalUnits );
if( g_UserUnit == INCHES )
{
if( aConvertToMils )
{
format = ( aInternalUnits == EESCHEMA_INTERNAL_UNIT ) ? wxT( "%.0f" ) : wxT( "%.1f" );
value *= 1000;
}
else
{
format = ( aInternalUnits == EESCHEMA_INTERNAL_UNIT ) ? wxT( "%.3f" ) : wxT( "%.4f" );
}
}
else
{
format = ( aInternalUnits == EESCHEMA_INTERNAL_UNIT ) ? wxT( "%.2f" ) : wxT( "%.3f" );
}
text.Printf( format, value );
if( g_UserUnit == INCHES )
text += ( aConvertToMils ) ? _( " mils" ) : _( " in" );
else
text += _( " mm" );
return text;
}
wxString& operator <<( wxString& aString, const wxPoint& aPos )
2008-05-05 19:43:56 +00:00
{
wxString temp;
2008-09-09 11:32:21 +00:00
aString << wxT( "@ (" ) << valeur_param( aPos.x, temp );
aString << wxT( "," ) << valeur_param( aPos.y, temp );
aString << wxT( ")" );
2008-05-05 19:43:56 +00:00
return aString;
}