kicad/include/kicad_string.h

106 lines
3.0 KiB
C
Raw Normal View History

/**
2009-11-23 20:18:47 +00:00
* This file is part of the common library \n
* Custom string manipulation routines.
* @file kicad_string.h
* @see common.h, string.cpp
*/
#ifndef __INCLUDE__KICAD_STRING_H__
#define __INCLUDE__KICAD_STRING_H__ 1
2009-11-23 20:18:47 +00:00
char* strupper( char* Text );
char* strlower( char* Text );
2009-11-23 20:18:47 +00:00
/* Read string delimited with (") character.
* Upload NbMaxChar max
* Returns the number of codes read in source
* dest is terminated by NULL
*/
int ReadDelimitedText( char* dest,
char* source,
int NbMaxChar );
2009-11-23 20:18:47 +00:00
/* Read one line line from a file.
* Returns the first useful line read by eliminating blank lines and comments.
*/
char* GetLine( FILE* File,
char* Line,
int* LineNum = NULL,
int SizeLine = 255 );
2009-11-23 20:18:47 +00:00
/* Remove leading and trailing whitespace.
*/
char* StrPurge( char* text );
2009-11-23 20:18:47 +00:00
/*Return a string giving the current date and time.
*/
char* DateAndTime( char* line );
wxString DateAndTime();
/*
2009-11-23 20:18:47 +00:00
* Routine (compatible with qsort ()) to sort by alphabetical order.
* Equivalent to strncmp () but the numbers are compared by their integer
* value not by their ASCII code.
*/
int StrLenNumCmp( const wxChar* str1,
const wxChar* str2,
int NbMax );
2009-11-23 20:18:47 +00:00
/*
* Routine (compatible with qsort ()) to sort by case insensitive alphabetical
* order.
* Equivalent to strnicmp () but the numbers are compared by their integer
* value not by their ASCII code.
*/
int StrNumICmp( const wxChar* str1,
const wxChar* str2 );
2009-11-23 20:18:47 +00:00
int StrLenNumICmp( const wxChar* str1,
const wxChar* str2,
int NbMax );
2009-11-23 20:18:47 +00:00
/* Compare string against wild card pattern using the usual rules.
* (Wildcards *,?).
* The reference string is "pattern"
* If case_sensitive == TRUE (default), exact comparison
* Returns TRUE if pattern matched otherwise FALSE.
*/
2009-11-23 20:18:47 +00:00
bool WildCompareString( const wxString& pattern,
const wxString& string_to_tst,
bool case_sensitive = TRUE );
2009-11-23 20:18:47 +00:00
/* Replaces decimal point with commas to generated international numbers.
*/
char* to_point( char* Text );
/**
* Function RefDesStringCompare
* acts just like the strcmp function but treats numbers within the string text
* correctly for sorting. eg. A10 > A2
* return -1 if first string is less than the second
* return 0 if the strings are equal
* return 1 if the first string is greater than the second
*/
int RefDesStringCompare( const wxString& lhs, const wxString& rhs );
/**
* Function SplitString
* breaks a string into three parts.
* The alphabetic preamble
* The numeric part
* Any alphabetic ending
* For example C10A is split to C 10 A
*/
int SplitString( wxString strToSplit,
wxString* strBeginning,
wxString* strDigits,
wxString* strEnd );
#endif // __INCLUDE__KICAD_STRING_H__