Home

Manual

1. 15 5 25 Tue TopMost WND FIELD IN THE BEHAVIOR DIALOG css ccccesessseceeesssceececesaeececessaececesensuececceaaseeeeeseaeseeceeses 15 5226 THE RESCAN Ss BUTTON 15 6 THE SETTINGS DIALOG ios EDS 16 6 1 THE APPLICATION WINDOW 16 6 2 RHE SEARCH SECTION 4 556 qr d rmi durae eat eda 17 6 3 THE EDITOR SECTION 18 7 THE RESCAWN DIAL OG isis ddesscossincceevseseesccses 20 8 THE INFO DIA LOG oasiscissccccsccccsssecsacsvastosteccvssivessivbecsesceissocsesssvescetessvessoevscesevbocsvbetesdscessinessisecsbescesvonsdesesvesses 20 9 THE TIPS DIALOG eiivesssisccsscsessesessssesteseviescossccsevbeessvsesssescviveesteleteseccessvessesesscestaseobesessucesssseecsbesevsusessesvevesusee 20 101 DATABASES i aiiscecsstessessscesssessesessicertveseuieseedcveosseessbnecesescvivonstedvevedsccedsbestesdcoesdeceubetesduvesesdvedsbebeddusonsesecsebentess 22 11 SPEEDING UP YOUR WORK 23 11 18 SACCREBRATORS ico unte eerta tte bu ie Ene uS ET 23 http www abego software de Where Is User Manual 3 11 2 BUTTON trece te cvi Groves bu aaa 24 11 35 DOUBLE CEICRS aes eta ts 24 MICA SHOREIGUIS Eos E emis
2. 42 Basic Steps 1 Into the Prefix field type the first letters of the word you re looking for 2 In the Index List select the entry you want and then click the button List Items or double click the entry 3 In the File View List double click a line starting with or to show or hide all findings in that file 4 Select a finding line and then click button Preview to view a finding in the Preview window Double clicking a finding will directly show that finding 43 More tips You may restrict the findings to words found in code in strings or comments by checking the corresponding check boxes Use button Next to navigate to the next finding and display it in the Preview pane Use button Open to open the currently selected finding in the external editor 5 The Application Window Prefix Field Result Area D Where Is The Search Utility 1 Type the first letters of the word you re looking for Find words in d gt M Code omo Strings 2 Click the Index entry you want and then click List Items Comments Leveld List Items Preview DoModal DoMouseWheel DoPaste Rescat DoPrepareDC DoPreparePrinting Database DoPrint New DoPrintDialog DoPrintPreview zi Open File View 17 files Logical View Alt Files F4 d 2 F5 int COlelnsertDialog DoModal DwORD dwFlags int nDisposition DoModal D CMGR CPP C Program Files
3. 9 D320 THE Parere DA VIEW bes eevee 12 5 0 FHE PREV N BUTTONS ERE 13 3 10 2 6e c nete tenete hte PE EE e 13 511 D 13 512 THE FIEENAME 13 197 THRICONTEXT 13 5 14 THE PREVIEW WINDOW cccccccscscsccesecccececesscssscsecescscseseccecescesenecsvaususussseseseecescecesesseauassussssscseeseseecereneneseanenees 13 5 15 THES BED occ 14 9 16 THE FIND SELECTION BUTTON 14 317 ST HE COPY BUTTON reete teet vue 14 59 16 E E A EA neatis divites ies 15 5 19 s SHOW BUTTON 15 5 20 THE INFOS BUTTON E E 15 5221 THES BEHAVIOR BUTTON doeet ose 15 5 22 THE SINGLE CLICK ON INDEX List FIELD IN THE BEHAVIOR 0 15 5 23 THE SINGLE CLICK ON ITEM List FIELD IN THE BEHAVIOR DIALOG cccssccccecesssceecesesseeceeceesscecceceseececesesceeeeees 15 5 24 Tue Open FELD IN THE BEHAVIOR 06
4. if returns NULL the user has already been alerted void CDocManager nFileOpen prompt the user with all document templates CString newName if DoPromptFileName newName AFX IDS OPENFILE OFN_HIDEREADONLY FILEMUSTEXIST TRUE NULL v Alt Font Sel Save _ Show Log Info Behavior Picture 1 The Application Window The Application Window is the main window you interact with You may resize and reposition the Application Window The window is restored at that size and position with the next application start The different parts of the Application Window are now described in detail 6 Where Is User Manual http Awww abego software de 51 The Prefix Field In the Prefix field you type the beginning of the word you are looking for Automatically the Index List displays the existing words that start with the entered text ignoring the case of the letter The first word in the Index List is automatically selected The words you looked for are remembered see also Search History You can access them through the drop down window of the Prefix Field This also reselects the word in the Index List 511 Finding Substrings using the Prefix Field Entering a prefix in the form lt text gt into the prefix field lists all items in the index list that contain lt text gt ignoring the case of the text It also finds occurances of the text in the middl
5. Installing Where Is is simple extract the file Wherels Install zip into a directory of your choice No further installation steps are necessary You can directly use the application by starting the Wherels exe program in the main directory For easier access you may want to add the application to the Windows Start menu 4 Working with Where Is IMPORTANT Before you start working with Where Is please read the Licence Agreement stored in the file Licence txt Only when you agree to that Licence you may use the software This chapter gives you a brief overview of the work with Where Is For details please refer to the reference part below 4 1 Preparations You can start the application by double clicking the Where Is application icon or a Where Is database file see Chapter Databases While the application starts the startup picture is displayed When you start Where Is the first time the Tips Dialog appears After reading the dialog you should close it The Application Window will appear Initially you need to specify what files need to be searched You do this in the Settings Dialog that pops up when clicking the Settings button After the files are specified they are scanned all words are extracted and stored in a database This allows fast subsequent searches because there is no need to scan the files again as long as they are no changed http www abego software de Where Is User Manual 5
6. You are looking for all occurances of 1 Go to the Prefix Window use the mouse or simply type 2 Start typing DoModal you may ignore the cases when typing Already after typing the word DoModal is selected in the Index List 3 Because List Items button is the already the Default button just pressing the Return key will start the search and the result is listed in the Result area The first finding is automatically selected and displayed in the Preview window 4 Because button is now the Default button continuing pressing the Return key will browse you through all occurances of the word 11 3 Double Clicks The following Double Clicks are supported Location Action Index List List Items Result Item List Expand Collapse for File Items Preview for other Items Open when Ctrl key is pressed 11 4 Shortcuts For frequently used commands easy to access special shortcut keys have been defined The following table lists them Key Meaning Esc Minimize application F2 Find Selection Shift F2 Find Context F3 Next F4 Back in Search History F5 Forward in Search History 24 Where Is User Manual http www abego software de F6 Open F7 Alt Files 11 5 Auto Activation of Prefix field When the application is activated the Prefix Field automatically gets the input focus with all te
7. Microsoft Visual Studio VC98 MFC BOOL CD ntEileN ame CString amp file int nR Result List void DLGPROP CPP C Program Files Microsoft Visual int CPropertyS heet D oModall void CPropertySheet CommonConstruct CwWnd m_pParentWnd pParentwnd m_psh hwndParent set in D void CPropertySheetE x CommonConstruct Cwnd pPa m_pParent Wind pParentWnd m_psh hwndParent set in D DLGPRNT CPP C Program Files Microsoft Visu DLGFNT CPP Files Microsoft Visual Studia DLGFILE CPP C 7Proqram Files Microsoft Visual Studia v AutoExpand Globals fist Expand All Next F3 pen ini x Filename Field C Program Files Microsoft Visual Studio C98 MFC SRC DOCMGR CPP void CDocManager OnFileNew Context Field Error no document templates registered with AfxMessageBox AFX IDP FAILED TO CREATE DOC return CDocTemplate pTemplate CDocTemplate m templateList Ge if m_templateList GetCount gt 1 more than one document template to choose from bring up dialog prompting user CNewlypeDlg dlgism templateList lt int nID dlg DoModal if nID IDOK pTemplate dlg m_pSelectedTemplate else return none cancel operation ASSERT pTemplate NULL ASSERT KIND F CDocTemplate pTemplate pTemplate gt OpenDocumentFile NULL
8. You are searching for the word CRect and the word was found in line 342 of file c Sample Sample cpp Assume you have specified 152 1 for the Arguments field When you now press the button your editor will be called with the argument 1342 NSampleNSample cpp 6 3 3 The Open Minimized Field The field specifies whether the editor should be started minimized only appears in task bar but no application window appears or normal This field is checked e g when the application invoked is not the real editor but just an intermediate application that invokes the editor see Using MS Visual Studio as an Editor 6 3 4 Using MS Visual Studio as an Editor By default the Microsoft Visual Studio is set up as the editor To avoid re opening the Microsoft Visual Studio with every command it is not invoked directly but through a helper application called MSDevInvoker exe It is located in Tools directory Using this helper it is possible to have only one Microsoft Visual Studio running all the time even when multiple Open commands are issued The settings for using MS Visual Studio as an editor are Path Tools MSDevInvoker exe Arguments 01 2 963 904 18 Where Is User Manual http Awww abego software de Open Minimized Checked Tip Checking the Topmost Wnd field and narrowing the Where Is application window to hide the Preview window and movin
9. stmt cue oM T 24 11 5 AuTO ACTIVATION OF PREHEXFIEED 25 12 DE INSTALLA VUL e 26 IEEE Qao Le 27 13 Y MANUAELY STOPPING CONTEXT e exe erre Eee E ee er ea UE Pepe CLE RR RENE 27 13 2 CUSTOMIZE THE NUMBER OF LINES IN THE INDEX LISTBOX cesses eene nene nn ener sinerent eret nennen nenne 28 4 Where Is User Manual http www abego software de 2 About Where Is Where Is is a visual tool for fast searches in text files It is especially designed for software developers that frequently have to look up words in C C Basic Java source files But it is also very useful when searching in any other kind of text file When you are using programs like grep FindInFiles etc a lot Where Is can help saving time in your daily work Beside searching for words it gives you sorted lists of words contained in the files summarizes and ranks the findings provides context information for the findings and supplies additional features to work more efficiently and simplifies common tasks Where Is is designed to improve your overall performance Shortcuts and commands for often used activity are supplied for quick access Other applications like Microsoft Visual Studio can be integrated in the work with Where Is 3 Installing Where Is
10. types of certain programming languages the other kinds are also supported non on Currently C files with extensions c cpp cxx h hpp inl inc Java files with extension java and Visual Basic Files with extensions bas cls frm are scanned in detail and words will be differentiated between Code String and Comment 5 3 The Index List The Index List displays a sorted list of existing words beginn with the first word that starts with the text entered in the Prefix field Only words that match the setting in the Words in section are displayed E g when only Strings is selected only words that are used somewhere in a string are displayed Tip When the prefix of a word is typed into the Prefix field and the word becomes visible in the Index List but is not selected but somewhere below the selection one can simply use the cursor down key to select the desired line Normally the cursor down key would select the next item in the listbox of the combobox because the combobox is the field with the focus You can still select the items in the list box with the cursor down key when the list box is popped up 5 4 The List Items Button Selecting a word from the Index List and clicking the List Items button searches the word in the files and display the result in the Result area You may also double click the word in the Index List inste
11. AFX MAP END MESSAGE App command to run the dialog void CDevToolsApp OnAppAbout CAboutDlg aboutDlg aboutDlg DoModal When searching for OnAppAbout the context BEGIN MESSAGE MAP CAboutDlg CDialog is displayed for void CDevToolsApp OnAppAbout not the global context Even searching for aboutDIg the local variable in CDevToolsApp OnAppAbout will return the wrong context To avoid these problems one can define a list of End Context Words in the INI file that will automatically close any context when read The INI file is called Wherels ini and is located in the Windows directory Example EndContextWords size 2 O END_MESSAGE_ MAP 1 END_DISPATCH_MAP The context is closed i e set to global when END MESSAGE MAP END DISPATCH MAP is found Notice size must give the number of items in the list The items are numbered starting with 0 For your convenience these two entries are automatically added to Wherels INI file when you start Where Is the first time http www abego software de Where Is User Manual 27 13 2 Customize the number of lines in the Index Listbox The maximal number of lines displayed in the index listbox can be configured through the Settings MaxIndexListLen 200 in the Wherels INI file 28 Where Is User Manual http www abego software de
12. RichE dit iew OnE ditPasteS pecial if dlg DoModal IDOK void CRichE ditView nE ditProperties dla Only Calls Find Context Shit F21 Next F3 Open irai Picture 7 The Logical View For certain kinds of files special groups may follow the global group E g in a C environment the lines in class contexts will directly follow the global group After the class contexts group the group with the remaining contexts will follow 5 8 1 The Only Calls Field When the Only Calls Field is checked only the calls to a function with the searched name are reported in the item list The list is ordered by the type of the receiver of the call This view is very useful when working with polymorhic functions E g a function GetName may be defined in several classes Using this view one can quickly identify the locations in the code that are calling a specific class Note This feature will only work well for C sources The current implementation does not implement a complete C compiler for the necessary analysis to create the view but uses some simplifications This implies that some calls may not be associated correctly Especially overloading of methods is not handled 12 Where Is User Manual http www abego software de 5 8 2 The Find Context Button The Find Context button looks for the last identifier in the currently selected item s context and search that identifier This
13. Where Is THE Search Utility Version 3 0 User Manual Copyright 1999 2006 abego Software GmbH All rights reserved http www abego software de Where Is User Manual http www abego software de 1 Contents 1 CONTENT 3 2 ABOUT PATE SED OR uem M 5 3 INSTALLING WHERE IS uinte i a aieiaa a ura Fa eO Gee ee Vo deo Due 5 4 WORKING WITH WHERE IS uo rob exa vL pev Pee enu aea su aue eU E Te Rue 5 MEN orici EEUU CONSORTIO TE TD 5 ADs BASIC STEPS EE EE E 6 2 33 Mca Lu E 6 5 THE APPLICA TION sdasscocsecessescdeseaseeseeseesedsesconsscocdessuseseessstsvencesenecessossisusesoes 6 9 1 SPE PREFIX BIBL DS e there nete titt AE a 7 5 2 THE WORDS SECTION si 8 53 ThE INDEX 8 94 List ITEMS BUTTON ee ie cv cecesescevenvctunivocvavaevcecesceievshestopavetueteesecessts 8 5 5 THE DATABASE SECTION cccccesesssesssceecesecccececeseeseseseueesusussscscseesesesecsessuauuueussssscscecesescesesensuauensustessssesseseesesenssesees 8 5 6 RESULT ARRAS Re me OE ne Qe 9 5177 SP HE BILE E
14. ad of clicking the List Items button to start the search see also chapter Speeding Up Your Work 5 5 The Database Section see also chapter Databases 5 5 1 The New Button Clicking the New button opens a dialog that lets you specify the location and name of the database file to create When the dialog is closed that database is created and the application now works on that database Typically you then select the Settings button to specify the files to be browsed 8 Where Is User Manual http Awww abego software de 5 5 2 The Open Button Clicking the Open button opens a dialog that lets you select the database master file you want to open The most recently opened databases are listed for easy selection You may use the Browse button to browse for the database file After closing the dialog the database is opened and the application now works on that database Don t mix up this button with the one in the Result Area that opens selected files 5 6 The Result Area The Result Area contains the result of the last search and buttons that can be used to work with the result You may choose between two differerent views on the result the File View and the Logical View Depending on the chosen view the Result Item List will display the found occurances of the word differently 5 7 The File View When choosing the File View tab the File View is displayed in the Result Area Fil
15. ase To shrink the database use Full Rescan from time to time Clicking the Cancel button will close the Rescan dialog without doing any rescan 8 The Info Dialog The Info Dialog shows general information about the application like version number copyright notice and so on Clicking the Show Tips button will display the Tips dialog 9 The Tips Dialog This dialog gives you some major information necessary to work with the application For more details you should read this user manual 20 Where Is User Manual http www abego software de Picture 12 The Tips Dialog By default this dialog is displayed on every program start To avoid this uncheck the Show again on next start button The Tips Dialog can also be displayed by clicking the Tips button in the Info dialog When you start Where Is the first time the Tips dialog pops up You can close the dialog by clicking button http www abego software de Where Is User Manual 21 10 Databases When the files are scanned index information is extracted to speed up future searches This index information is stored in a database When you open Where Is the first time a default database is used This database SymDB is located in your temp directory typically called c temp or c tmp Using only one database may be sufficient for most cases But you may also create addit
16. automatically after a search When the field is unchecked the files are initially collapsed after a search and must be expanded manually either by double clicking the file line or using the Expand button WINCORE CPP D Programme MHicrosoft Visual 4 VIEwRICH CPP D Programme MHicrosoft Visual VIEWPRNT CPP D Programme Microsoft Visual PPGPICT CPP D Programme Microsoft Visual Studio OLEUI2 CPP D Programme Microsoft Visual Studio OLEMSGF CPP Programme Microsoft Visual OLEDLGS3 CPP D Programme Microsoft Visual OLEDLGS2 CPP D Programme Microsoft Visual a ni Eni 61 cpp N JProarsmmo Viewsl Picture 5 Result Item List with Collapsed Files Because expanding files will take some time especially when there are a lot of files found you may uncheck this field to speed your work and only expand the files of interest When a word is found in too many files the AutoExpand field is ignored and the files are all displayed in collapsed mode to avoid long waiting times 5 7 3 Globals First Field When the Globals First field is checked the first line in global context is selected after a search Subsequent use of the Next button will select the next global line After all global lines are visited Next continues with the non global lines When the field is unchecked the first found line in the list is selected after a search and subsequent use of the Next button will just m
17. cify more than one directory in this field by separating them with semicolons For example C Scribble d MyProjects will search for files in the directories C Scribble and d MyProjects and all their subdirectories The directories you entered are remembered by the application Later you may re select the most recently used entries through the drop down window of the field 6 2 2 The WildCards Field This specifies the extensions of the files to be searched for This restricts the files to be searched to those that have an extension listed in this field An extension is specified in the form xxx You may specify more than one extension in this field by separating them with semicolons For example c will search for all C or C source files in the directories given in the Directories to search field The wildcard selects all files You may choose some commonly used wildcard selections from the drop down box of the field 6 2 3 The Alternative WildCards Field In addition to the wildcards specified in the WildCards field you may specify a second alternative set of wildcards in the Alternative WildCards field These extensions are used when Files field in the Result area is checked It restricts the files to be searched to those that have an extension listed in this field Typically you will specify two different set of wildcard in the two wildcard fi
18. e of the item Example Typing context in the Prefix field may list contextStart GetContext inGlobalContext itemContext m context m contextEnd You may even use the wildcard character in the middle of the text you enter in the Prefix field And even multiple wildcards can be specified All words are returned that match the given text with any characters matching the gt Example When searching for all items that start with Get and contain String one would specify Get String This would result in a list like this GetProfileString GetStringEnd GetSubString GetValueAsString http Awww abego software de Where Is User Manual 7 5 2 The Find Words in Section Where Is not only searches for raw text you have chosen but also checks container of the word You may restrict your search to occurances of the word in Code Strings or Comments by checking the corresponding fields in Find Words in section When the Level 0 field is checked only words at level Zero global level are listed E g one gets global functions definitions but no function calls Of cause you may also select any combination of these fields This is a feature that tools like grep or FindInFiles don t provide The meaning of Code String or Comment varies from file type to file type By default a word is assumed to be in Code For file
19. e View 20 files Picture 2 The File View Tab The number of files that contain the searched word is displayed behind the text File View in tab The Result Item List contains several kinds of information retum TRUE 77 always ok DoModal actually brings up dialog HWND CDialog PreModal 47 cannot call DoModal on a dialog already constructed moc DLGCLR CPP C Program Files Microsoft Visual Studio C38 MFf int CColorDialog DoMaodal APPPRNT CPP C Program Files Microsoft Visual Studio VT int CWinApp DoPrintDialog CPrintDialog pPD int nResponse pPD DoModal nResponse pPD DoMadal 2 Picture 3 The Result Item List in File View File expanded A File line contains the name of the file containing the search word followed by the path of the file The file name is preceded by a minus or plus indicating whether the details for that file are displayed file is expanded or the details are hidden the file is collapsed Double clicking file line will toggle between expanded and collapsed mode HWND LUlIalog rremodaltJ 7 cannot call DoModal on a dialog already constructed as moc DLGCLR CPP 2 Files Microsoft Visual Studia C Program Files Microsoft Visual Studio VT int Mufindnn NoaPrintNialooffPrintNialoan nPn1 Picture 4 A collapsed file in File View When a file is expanded the list of lines containing the word follows group
20. e corresponding line selected in the preview window When you do a Find Selection you are most likely interested in other locations that the one currently selected For this reason the second item is selected when the first item found after clicking the Find Selection button is the same that started the search 5 17 The Copy Button The Copy button copies the current selection of the Preview Window into the clipboard It adds an extra line containing a reference to the origin of the selected text This feature is useful when source code is analysed and the analysis must be documented Example Pressing the Copy button in the following situation invoke the dialog DleLll D bjectProperties amp m op LL return iR esult Picture 8 Copy Example will lead to the following text in the clipboard D Programme Microsoft Visual Studio VC98 MFC SRC OLEDLGS3 CPP 89 m op lpPS hwndParent PreModal int iResult MapResult OleUIObjectProperties amp m op PostModal If you don t want that extra line with the reference you may switch it off with the following setting in the WherelIs INI file Settings AddCopyComment 0 14 Where Is User Manual http www abego software de 5 18 The Save Button The Save button can be used to save changes done to the file in the Preview window 5 19 The Show Log Button The application maintains a log file that con
21. ed by their context http www abego software de Where Is User Manual 9 5 7 1 The Context To make it easier for you deciding whether the found line is relevant for your work the Result Item List displays a line s context beside the line itself The context depends on the kind of file and the location of the line within that file In general you can think of the context as the next higher level component the found word is in E g when a word is in the body of the function the function header is displayed as the context or the class name is displayed for words in class declarations When no context is displayed the word is in global context The context varies from file type to file type Not for all file types the context is supported In those cases all lines are in global context non on Currently C files with extensions c cpp cxx h hpp inl inc Java files with extension java and Visual Basic Files with extensions bas cls frm display a context Note Because no preprocessor commands are evaluated when C files are scanned the context may be wrong missing when preprocessor commands are used in some special ways Some problems can be solved by using the approach described in the chapter Manually stopping a context given in the appendix 5 7 2 AutoExpand Field When the AutoExpand field is checked all files in the Result Item List will be expanded
22. eld E g you may specify all source file extensions in the WildCards field and all header file extensions in the Alternative WildCards field So you can later restrict your searches easily to just the header files by checking Files field See also chapter WildCards field http www abego software de Where Is User Manual 17 6 3 The Editor Section The Editor Section specifies the editor application that should be used with command Note the settings done in the Application Window and Search section are database specific and apply to the currently open database In contrast to this the values entered in the Editor section are global and apply to all databases 6 3 1 The Path Field Whenever the command is invoked the application specified in this field is called with the parameters given in the Arguments fields You may use Browse button that allows you to choose an application in a Choose File dialog But you may also type in the path directly 6 3 2 The Arguments Field The arguments specified here will be passed to the editor application whenever the command is invoked Placeholders can be used that are substituted with the actual values for every Placeholder Meaning 1 filename 2 line 3 text to find 4 activate flag 1 activate 0 don t activate editor Example
23. feature is useful e g when searching a call tree backwards i e who called the function in this line 5 8 5 The Open Button See The Open Button in the chapter File View 5 9 The Preview Button The Preview button displays the file of the item currently selected in the Result Item List in the Preview window either a context or a found line and selects the found line in the Preview window see also The Open In Editor Field 5 10 The Find History The application maintains a history of the identifiers searched for One can move back and forward in that history When moving in the history the former searches are repeated and the last selected item for that item is re selected This feature is very useful when following call trees etc Note When using the Find History one should avoid switching between File View and Logical View because the remembered item might not be found accurately in that case 5 10 1 The lt Back in History Button Moves back in the search history to the previous search 5 10 2 The gt Forward in History Button Moves forward in the search history This is only useful when one moved back in the history earlier 5 11 The Alt Files Field When Files field is checked only files are searched that match the extensions specified in the Alternative WildCards field of the Settings Dialog When the field is unchecked the WildCards field is
24. ftware de 11 Speeding Up Your Work The application has several features that can speed up your work 11 15 Accelerators Most fields of the windows can be reach through accelerator key The following table lists the accelerators of the application window Key Meaning Alt 1 Prefix Alt 2 Item List Alt A Expand All Collapse All Alt C Code Find words in Alt D Find Context Alt E Settings Alt F Find Selection Alt I Open in editor Alt G Globals first Alt H Show Log Alt L List Items Alt N Next Alt O Comments Find words in Alt P Open Alt R Rescan Alt S Strings Find words in Alt T Topmost Wnd Alt V Save Alt W Preview Alt X AutoExpand Alt Y Copy htto www abego software de Where Is User Manual 23 After you have become familiar with the application you will find it more efficient to navigate to certain field with a key press rather than using the mouse Example You already did a search and now you want to search for a different word Pressing 1 will move your cursor to the Prefix field and you can directly start typing the new word without the hands leaving the keyboard 11 2 Default Button The Default button changes dynamically based on the actual situation The application tries to find out what the next most likely action may be and makes that button the Default button Le most times you only have to press the Return key to initiate your next step Example
25. g Where Is to the left has been proven to be a very efficient way of working with the two applications You may also check the Open in Editor field where Is The Search Utility Ux ni x 1 Type the first letters of the word you re looking for Find words in sf Code Strings 2 Click the Index entry you want and then click List Items Comments REX Xe Level EN si f 05 ouseWheel List Items END Preview 3 void CRichEditView OnSelChange NMHDR pNMHDR LRESULT pResult 1 ASSERT pNMHDR gt code EN SELCHANGE Settings UNUSED pNMHDR not used in release builds Bescan DoPrepareDC m_bSyncCharFormat m_bSyncParaFormat TRUE DoPreparePrinting Database x pResult 0 DoPrint New DoD og zi Open void CRichEditView OnDestroy DoPrintPreview if m_lpRichEditOle NULL File View 17 fies Logical View Alt Fies arf F5 n lpRichEditOle Release CCtrlVi OnDest WINCORECPP _C Program Files Microsoft Visual Studio a BOOL CWnd UpdateD ata BOOL bSaveAndValidate y 4 j ASSERT Iswindow m hwndJJ calling UpdateData before vor CRichEditView OnEditProperties VIEWRICH CPP m Files Microsoft Visual Studio V ASSERT n_lpRichEditOle NULL heute CRichEditCntrItem pSelection GetSelectedItem if dla DoModal void CRichE ditView nE ditProperties 7 make sure item is in
26. he parameters for the invokation must be specified in the settings dialog see The Settings Dialog The Open button opens the selected file using the external editor setup in the Settings dialog and selects the found line in the editor Some editors may not be able to select the found line http www abego software de Where Is User Manual 11 5 8 The Logical View When choosing the Logical View tab the Logical View is displayed in the Result Area 5 Logical View Picture 6 The Logical View Tab The Logical View looks very similar to the File View but the file lines are omitted In addition the lines are sorted in a special way The list starts with the global lines followed by the lines with concrete contexts These groups are separated with a dashed line C class and enum definitions are displayed first in the item list So when you are searching for a name that also is a class or enum name the class or enum definition will be selected first This is very useful e g when looking for the possible values of an enum or the members of a class that you know the name of This does not work for nested definitions but only for global ones File View 21 files Logical View At Files I4 d gt res virtual int DoModall BOOL m bModeless TRUE when Create called instead BOOL Cwnd UpdateD ata BODL bSaveAndV alidate ASSERT Iswindow m Hhwnd 2 calling UpdateData before 4 void C
27. ional databases that can be used in parallel E g you may create a database for a large set of sources that is stable like from a framework or library e g the MFC sources This database will not need any rescans In addition you create a database for your sources You can now search for things either in sources or in your code without mixing up things And when your sources changed and you do a rescan this will be fast because you don t need to rescan the MFC sources A Where 15 database consists of two parts a master file with the extension e g MySources whe and a directory with additional files located in the same directory as the master file and named as the masterfile without extension e g You may doubleclick the master file to open the database In this case the Where Is application starts up and lets you work on that database You may start multiple Where Is databases at a time and work on them in parallel For each database a separate application will start with its own application window You may switch between the applications as usual e g using the task bar etc You can not work on the same database with two applications The name of the currently used database is displayed in the Settings dialog When you de install Where Is you have to delete the database master files and database directories manually 22 Where Is User Manual http www abego so
28. ior dialog When the Topmost Wnd field read Topmost Window is checked the application window of Where Is will always be above other application windows This can be very useful especially when using Where Is together with an external editor see chapter The Settings Dialog 5 26 The Button The button opens the Rescan Dialog see chapter Rescan Dialog http www abego software de Where Is User Manual 15 6 The Settings Dialog When clicking the Settings button the Settings dialog will pop up Settings Database C Temp MSSymbols D Programme Microsoft Visual Studio v C38 h hpp inc inl hpp hs inl D Users ub Data S Projectswherels MSDevlnvoker 2 753 4 Picture 9 The Settings Dialog The title of the dialog contains the name of the currently used database The Settings dialog has several sections 6 1 The Application Window Section This section is used to specify the visual appearance of the main window for the current database 6 1 1 The Title Prefix Field A text may be specified in the Title Prefix field that is used as a prefix for the title of the application main window This feature is very nice when using multiple Where Is databases simulatiously see Chapter Databases Typically you will use a title
29. l Rescan will take a while Fast Rescan scans all files that have been changed since the last scan and adds their words to the database Typically Fast Rescan is faster than Full Rescan Because the database was not cleared when using Fast Rescan it may contain words files that are no longer used So Fast Rescan may lead to a growing database To shrink the database use Full Rescan from time to time Please choose the desired rescan version Cancel Full Rescan Picture 11 The Dialog After the directories files to be scanned are specified in the Settings Dialog see chapter The Settings Dialog the files are scanned immediately and some index information is stored in the Where Is database When the files are changed it is necessary to re scan the files to update the Where Is database to the current state Otherwise it may happen that words added to the files since the last scan are not found Clicking the Full Rescan button clears the database and scans all files adding their words to the database Typically Full Rescan will take a while Clicking the Fast Rescan button scans all files that have been changed since the last scan and adds their words to the database Typically Fast Rescan is faster than Full Rescan Because the database is not cleared when using Fast Rescan it may contain words files that are no longer used So Fast Rescan may lead to a growing datab
30. ove to the next found line independent of the context Most time the global lines are the ones that are most interesting E g a function definition will be in global context and its usage calls are in concrete contexts 10 Where Is User Manual http Awww abego software de 5 7 4 Expand Buttons Pressing button will expand all files in the Result Item List Pressing Collapse button will collapse all files in the Result Item List 5 7 5 The Next Button The Next button moves the selection in the Result Item List to the next found line and shows that line in the Preview window See also Globals First Field The End of Index List Beep When the Next buttom is clicked and all items in the item list have been visited the last item is selected the first item is selected and a beep notifies the user that all items are visited and we are starting again at the top The sound that is played can be configured e g switched off through the standard Windows Sounds control panel The sound is defined by the event Wherels End of index list reached in the Windows section of the Sounds control panel 5 7 6 The Open Button Beside the Preview window an external editor can be used to browse through the findings and navigate through the found lines Before an external editor can be used the path to the editor application and t
31. sync with richedit s item CReObject reo void CRichE ditView OnF ormatFont GETOBI NO INTERFACES 7 ELECTION if dlg DoModal IDOK ES ES void CRichE dit View OninsertObject pSelection SyncToRichEdi tObject reo E if dlg DoModal IDOK COlePropertiesDialog dlg pSelection dlg VIEWPRNT CPP C Program Files Microsoft Visual Studio V void CView nFilePrint if dlg DoModal IDOK void CRichEditView OnUpdateEditProperties CCmdUI pCmdUI CT CPP C Program Files Microsoft Visual Studio VC98 MFC void CPicturePropPage nBrowse gt m oen uA AutoExpand Globals first Collapse Al Next Faf Open F6 void CRichEditView OnCharBold pCmdUI Enable GetSelectedItem NULL xil ine12 Coli COL OVA READ Z Find Files 2 4 Results SQL Debugging 7 Picture 10 Using Where Is together with Visual Studio When the Where Is application is not needed temporarily or may disturb the work with Visual Studio Where Is can be hidden minimized very quickly with an Esc keystroke http www abego software de Where Is User Manual 19 7 The Rescan Dialog The Rescan Dialog lets you start a rescan in two different ways Rescan can be done in two ways Full Rescan clears the database and scans all files adding their words to the database Typically Ful
32. tains information about errors that occured e g when files are scanned The Show Log button displays this log file s contents in the Preview Window You should have a look at the log file especially after you have specified new directories files to scan 5 20 The Info Button The Info button opens Info dialog see chapter Info Dialog 5 21 The Behavior Button The Behavior button opens the Behavior dialog to edit some preferences 5 22 The Single Click on Index List Field in the Behavior dialog When the Single Click on Index List field is checked a single click rather than a double click on an item in the Index List will automatically start the search and update the Result list 5 23 The Single Click on List Field in the Behavior dialog When the Single Click on Item List field is checked a single click rather than a double click on an item in the Result List either in File View or List View will automatically open the selected item in the Preview window 5 24 The Open In Editor Field in the Behavior dialog When the Open In Editor field is checked every time a found line is previewed either automatically or by pressing the Preview button the file is also displayed in the external editor and the found line is selected as described in chapter Open Button 5 25 Field in the Behav
33. that identifies the stuff the current database has scanned Example You created a database that scans the MFC source directory for quickly browsing that sources You will set the Application Window Prefix in the Settings dialog to MFC for that database 16 Where Is User Manual http www abego software de The database with your source you may associate with the sources My Sources When you later start both applications you can quickly identify the different databases through the titles even in the task bar 6 1 2 The Icon Field In addition to the Application Window Title Prefix the user can select the color of the application icon to be displayed when running the application on a specific database So you can identify correct database with a quick view without reading any title Example see also example for Title Prefix For your MFC database you may choose the red and for Sources green icon 6 2 The Search Section This section is used to specify the files to be searched 6 2 1 The Directories to search Field The directories to be searched are specified in the Directories to search field You may use Browse button that allows you to choose a directory in a Choose Directory dialog But you may also type in the directory path directly When specifying a directory the files in this directory and all its subdirectory are selected You may also spe
34. used instead See also The Alternative WildCards Field in the chapter Settings Dialog 5 12 The Filename Field The Filename field displays the filename of the file currently displayed in the Preview window 5 13 The Context Field The Context Field displays the context of the last finding that was displayed in the Preview window 5 14 The Preview Window The Preview Window is used to display the currently selected file s contents and select the found line http www abego software de Where Is User Manual 13 The window s main purpose is inspecting viewing the file but one may also modify the file s contents 5 15 The Alt Font Field When Font field is checked file contents in the Preview Window is displayed in an alternate font rather than the standard proportional font The alternate font used in the Preview window can be configured through Settings AltFontName Courier New AltFontSize 12 in the Wherels INI file By default a fixed font Courier New 12 is defined Fixed fonts make it easier to read indented texts but normally use up more space in a line 5 16 The Find Selection Button The first identifier of the selection in the Preview Window is searched When the selection is empty i e just a caret Find Selection will find the word around the caret Note After a search typically the first item in the list of found items is selected and th
35. xt selected Background typically you will activate the application to search for a new word that you want to enter in the Prefix field When the Prefix field is automatically activated after application activation you don t not need to navigate to it manually with the mouse or accelerator http www abego software de Where Is User Manual 25 12 De Installation To de install Where Is you simply need to remove the installation directory and the file Wherels ini from the Windows directory When you have added the application to the Windows Start menu you need to remove it manually In addition you should remove the Where Is databases that consists of the database master file with the extension whe and the database directory with the same name as the master file but without extension for details see chapter Databases 26 Where Is User Manual http www abego software de 13 Appendix 13 15 Manually stopping a context When C macros are used to extend the language it may happen that the build in algorithm to determine a context fails see section Context in chapter File View Typical examples are the BEGIN MESSAGE MAP END MESSAGE MAP blocks used in Microsoft MFC In this case the first function following such a block is reported to be in the BEGIN MESSAGE MAP context Example BEGIN MESSAGE MAP CAboutDlg Cdialog AFX MAP CAboutDlg No message handlers

Manual

Contents

Download Pdf Manuals

Related Search

Related Contents