eda_doc.h File Reference

This file is part of the common library. More...

Go to the source code of this file.

Functions
bool	KeywordMatch (const wxString &aKeys, const wxString &aDatabase)
	Function KeywordMatch searches aKeyList for any words found in aDatabase. More...
bool	GetAssociatedDocument (wxWindow *aParent, const wxString &aDocName, const wxPathList *aPaths=NULL)
	Function GetAssociatedDocument open a document (file) with the suitable browser. More...

Detailed Description

This file is part of the common library.

See also

common.h

Definition in file eda_doc.h.

Function Documentation

GetAssociatedDocument()

bool GetAssociatedDocument	(	wxWindow *	aParent,
		const wxString &	aDocName,
		const wxPathList *	aPaths = NULL
	)

Function GetAssociatedDocument open a document (file) with the suitable browser.

Environmental variables are substituted before the document name is resolved for either browser or file

Parameters

aParent	= main frame
aDocName	= filename of file to open (Full filename or short filename) if aDocName begins with http: or ftp: or www. the default internet browser is launched
aPaths	= a wxPathList to explore. if NULL or aDocName is a full filename, aPath is not used.

Definition at line 87 of file eda_doc.cpp.

{
    wxString docname, fullfilename;
    wxString msg;
    wxString command;
    bool     success = false;

    // Is an internet url
    static const wxChar* url_header[] = {
        wxT( "http:" ),
        wxT( "https:" ),
        wxT( "ftp:" ),
        wxT( "www." ),
        wxT( "file:" )
    };

    // Replace before resolving as we might have a URL in a variable
    docname = ResolveUriByEnvVars( aDocName );

    for( unsigned ii = 0; ii < arrayDim(url_header); ii++ )
    {
        if( docname.First( url_header[ii] ) == 0 )   // looks like an internet url
        {
            wxURI uri( docname );
            wxLaunchDefaultBrowser( uri.BuildURI() );
            return true;
        }
    }

#ifdef __WINDOWS__
    docname.Replace( UNIX_STRING_DIR_SEP, WIN_STRING_DIR_SEP );
#else
    docname.Replace( WIN_STRING_DIR_SEP, UNIX_STRING_DIR_SEP );
#endif


    /* Compute the full file name */
    if( wxIsAbsolutePath( docname ) || aPaths == NULL)
        fullfilename = docname;
    /* If the file exists, this is a trivial case: return the filename
     * "as this".  the name can be an absolute path, or a relative path
     * like ./filename or ../<filename>
     */
    else if( wxFileName::FileExists( docname ) )
        fullfilename = docname;
    else
    {
        fullfilename = aPaths->FindValidPath( docname );
    }

    wxString mask( wxT( "*" ) ), extension;

#ifdef __WINDOWS__
    mask     += wxT( ".*" );
    extension = wxT( ".*" );
#endif

    if( wxIsWild( fullfilename ) )
    {
        fullfilename = EDA_FILE_SELECTOR( _( "Doc Files" ),
                                          wxPathOnly( fullfilename ),
                                          fullfilename,
                                          extension,
                                          mask,
                                          aParent,
                                          wxFD_OPEN,
                                          true,
                                          wxPoint( -1, -1 ) );
        if( fullfilename.IsEmpty() )
            return false;
    }

    if( !wxFileExists( fullfilename ) )
    {
        msg.Printf( _( "Doc File \"%s\" not found" ), GetChars( docname ) );
        DisplayError( aParent, msg );
        return false;
    }

    wxFileName currentFileName( fullfilename );

    wxString file_ext = currentFileName.GetExt();

    if( file_ext.Lower() == wxT( "pdf" ) )
    {
        success = OpenPDF( fullfilename );
        return success;
    }

    /* Try to launch some browser (useful under linux) */
    wxFileType* filetype;

    wxString    type;
    filetype = wxTheMimeTypesManager->GetFileTypeFromExtension( file_ext );

    if( !filetype )       // 2nd attempt.
    {
        mimeDatabase = new wxMimeTypesManager;
        mimeDatabase->AddFallbacks( EDAfallbacks );
        filetype = mimeDatabase->GetFileTypeFromExtension( file_ext );
        delete mimeDatabase;
        mimeDatabase = NULL;
    }

    if( filetype )
    {
        wxFileType::MessageParameters params( fullfilename, type );

        success = filetype->GetOpenCommand( &command, params );
        delete filetype;

        if( success )
            success = ProcessExecute( command );
    }

    if( !success )
    {
        msg.Printf( _( "Unknown MIME type for doc file \"%s\"" ), GetChars( fullfilename ) );
        DisplayError( aParent, msg );
    }

    return success;
}

References arrayDim(), DisplayError(), EDA_FILE_SELECTOR(), EDAfallbacks, GetChars(), mimeDatabase, OpenPDF(), ProcessExecute(), ResolveUriByEnvVars(), UNIX_STRING_DIR_SEP, and WIN_STRING_DIR_SEP.

Referenced by FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDA_BASE_FRAME::GetKicadHelp(), TEXT_BUTTON_URL::OnButtonClick(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), PCB_EDIT_FRAME::Process_Special_Functions(), and EE_INSPECTION_TOOL::ShowDatasheet().

KeywordMatch()

bool KeywordMatch	(	const wxString &	aKeys,
		const wxString &	aDatabase
	)

Function KeywordMatch searches aKeyList for any words found in aDatabase.

Returns

true if keyword is found.

Definition at line 215 of file eda_doc.cpp.

{
    if( aKeys.IsEmpty() )
        return false;

    wxStringTokenizer keyTokenizer( aKeys, wxT( ", \t\n\r" ), wxTOKEN_STRTOK );

    while( keyTokenizer.HasMoreTokens() )
    {
        wxString key = keyTokenizer.GetNextToken();

        // Search for key in aDatabase:
        wxStringTokenizer dataTokenizer( aDatabase, wxT( ", \t\n\r" ), wxTOKEN_STRTOK );

        while( dataTokenizer.HasMoreTokens() )
        {
            if( dataTokenizer.GetNextToken() == key )
                return true;
        }
    }

    // keyword not found
    return false;
}