|
SrcEdit is a source code editor specially written to be used with OnBoardC, but it works well with other environments too like PP compiler, iziBasic, and Plua. SrcEdit is also suited for editing 68kASM and HTML.
A load of work has been put down to make SrcEdit reliable and easy to use, at the same time as a large range of features has been carefully adapted and incorporated. SrcEdit is a great programming tool, small enough to fit in the palm of your hand.
Since this manual deals with SrcEdit, some of the subjects belonging to the OnBoard Suite as a whole, like licensing, installation etc., will only be mentioned briefly.
SrcEdit is provided under the GNU General Public License (GPL). If you want to know more, please visit the Free Software Foundation website .
- Sony Clié 480x320 screen support
- Flexible user interface
- Configurable Toolbar
- Resource Font support
- Configurable Source Code Color Scheme
- Quick jump between the Most Recently Used files--MRU.
- Jump Between two places within a file
- Select Between cursor and a marked position.
- Comment/Uncomment tools
- Block indenting
- Find/jump to function with Function Bookmarks
- Find/complete API function name with Keyword Complete
- API function parameter lookup with Header Parameters
- + a lot more
A PDA with Palm OS 3.0+. Color screen recommended.
Copy srcedit.prc and optionally a skin file of your choice into your palm's RAM, using the normal installation procedure.
Visit the OnBoardC Discussion Group. There you'll meet some really nice and helpful people, you'll find useful documents and other files, and you'll be able to search the archive of discussion topics.
SrcEdit's main form components
- The text editing area
- The text scrollbar
- The Scroll left and scroll right button
- The Menu (normally not visible)
- The Toolbar
How to Scroll Up And Down
There are two ways to scroll the text up and down:
- The text scrollbar on the right.
A tap on the small arrows at each end of the scrollbar scrolls the text one line.
A tap on the bar above or below the handle will scroll one whole page up or down.
Drag the handle to move to fast to any position in the file.
- The hardware up and down buttons. For devices with 5-way navigator, see Menu/Options/Navigator for configuration of behavior.
How to Scroll Left And Right
As SrcEdit is a source code editor, it does not wrap the text lines, in the text editing area, to screen. A long line therefore continues outside the right margin of the screen where it only finishes with a linefeed. To be able to see beyond the limit of the screen, there are three ways to scroll sidewards:
- The scroll left and right buttons down in the right corner of the screen.
- The left and right buttons on machines with 5-way navigator. See Menu/Options/Navigator for configuration of behavior.
- Two hardware buttons configured for the purpose. See Menu/Options/Navigator
* Useful for devices without 5-way navigator, or if the 5-way navigator is set on Moving Cursor. .
How to Select Text
A word: Double tap on the word.
A word using the 5-way navigator: Place the cursor immediately before the word, in the word, or immediately after the word and double click on the 5-way navigator's center button.
A line: Triple tap somewhere on the line.
A line using the 5-way navigator: Place the cursor somewhere on the line and triple click on the 5-way navigator's center button.
Multiple lines, normal method: Put and hold down the stylus where you want the selection to begin, and drag over the text to be selected.
Multiple lines using Select Between: Place the cursor at the beginning of the selection. Tap on Menu/Edit/Mark Position. Move the cursor to the end of the selection and tap on Menu/Edit/Select Between.
* Mark Position and Select Between can also be found as a Toolbar function and in Popup Tools.
The whole document: Choose Menu/Edit/Select All
or use the short cut: /A
Using the 5-way navigator: The 5-way navigator's center button may be used for selecting a word by a double click or a whole line by a triple click.
To select a word place the cursor immediately before the word, in the word, or immediately after the word and double click on the 5-way navigator's center button.
More on selecting: See the SEO section for how to resize a selection, how to find a matching parenthesis, and how to find a matching curly brace.
How to Get to the Features
SrcEdit's functions are reached through the following:
Most of functions can be invoked in several ways, so that the user can choose the way he likes best. The functions will be explained in order they appear in The Menu.
The menu is reached by tapping the menu silkscreen button.
On each menu you find the name of the different items to the left and their shortcuts to the right. The shortcuts can be entered unshifted (lower case) ex. the shortcut "/H" can be entered as "/h".
Most menu items opens a window with the menu and item names as headline. The window's contents varies, but two buttons remains the same: the OK and the Cancel buttons. The OK button executes the task of the window . The Cancel button closes the window without any action. Cancel is a good choice if you don't know what to do, but if that happens, a good advice is: read the rest of this manual. If you don't, you will surly miss many of SrcEdit's hidden functions.
Other buttons which may appear will be explained later, but the OK and Cancel buttons will never be mentioned again.
(Window: New File)
Creates a new doc file.
Type in the name of the new file. Limit: 31 characters.
(Window: Open File)
Saves the opened doc file and opens an other one.
Choose which file to open in the file list.
(Window: Reload File)
Substitutes the opened doc file with the last saved version of the same.
* Warning! This will delete everything that was changed since the last time it was saved.
(Window: none)
Saves the file.
* SrcEdit automatically saves the current document upon: device shut down or sleep, or application stop.
(Window: Save File as)
Saves the opened doc file under another name.
Type the new name.
(Window: Delete File)
Deletes doc files.
Select the file to be deleted in the file list and tap Delete. More files can be deleted, but only one at the time. When you ready, tap on Close to close the window.
(Window: File Info)
Displays information about the opened doc file. It also makes it possible to change category and file attributes.
DB Name: The name of the doc file
Date: Choose to see dates and time when the file was created, last modified, and last synchronized.
Resides on: Shows where the file is--in RAM , ROM (flash memory) or VFS.
Version: A number that increases each time the file is saved. Can be used to determine the latest version
Category: A way of identifying files belonging to a specific project.
Set a number from 1 - 15 with which you can group your files. By giving the categories different colors under Menu/Options/Preferences-Customize, the groups will show up with it's own colors in the Menu/File/Open file list.
DB Size: The file size in bytes
# Rec: The number of records the file consists of.
Doc Size: The size of the text in bytes.
Compr. Size: (For future use.) Will show the size of the compressed file.
# Lines: The number of lines in the text.
# Words: The number of words in the text.
File Attributes (can be changed)
Backup: If checked, backup during HotSync.
Read Only: If checked, no changes to this document will be saved.
Beam Prvnt: If checked, this document is prevented from being beamed.
Secret: If checked, the file is set to Private. See Operative System/Preferences/Security/Current Privacy.
(Window: none. Also available in: Toolbar, Popup tools.)
Copies selected text to the clipboard and then erases it the text.
(Window: none. Also available in: Toolbar, Popup tools.)
Copies select text to clipboard.
(Window: none. Also available in: Toolbar, Popup tools.)
Pastes the contents of the clipboard into the text at the place of the cursor, or a selected text which will be replaced,
(Window: none. Also available in: Toolbar.)
Makes up for your mistakes and undos the last text operation you did.
* Only the latest operation can be undone.
(Window: Find/Replace. Also available in: Toolbar, Popup Tools.)
Finds a word or phrase and optionally replaces it.
The Find/Replace dialog has two text fields.
In the upper one, the Find field, you write the text you want to find.
In the lower one, the Replace field, you write what you want to Replace the found text with. If you only want to find, you can leave the Replace field empty.
* The linefeed character is not accepted.
Find
1. Write the text you are looking for in the Find field.
* If you have a text selected when opening the Find/Replace dialog, the selected text will appear in the Find field and Find/Replace will find the next occurrence of the selected text.
2. Choose setting of Ignore case and Search from top.
* If you don't check Search from top the search will start from the cursor position and finish at the end of the document.
3. Tap on the Find button. SrcEdit will now search for the next occurrence of the text you were looking for and then close the window.
If the search is the successful, the text found will appear as selected. Otherwise the original selection will be shown.
Replace
With the Find field filled in, write what the searched text should be replaced with, in the Replace with field. A tap on the Replace button and the next occurrence of the text in the "Find" field, will be replaced, and the window closed.
Replace All
Tapping Replace All replaces all occurrences of the searched text before the window closes.
Selected Search Area
Select the section of the text (several lines) inside which you want to search.
Bring up the Find/Replace window and proceed according to the instructions above, without checking Search From Top. Find and Replace will now only work inside the selected search area.
(Window: none. Also available in: Toolbar.)
After having performed a Find, Find Again will find the the next occurrence of the text entered in the Find field of the Find/Replace dialog.
(Window: none.)
Selects the whole text in the document
(Window: Goto Line.)
Shows the line number of the current cursor position in the Line # field when the window opens.
To go to a specific line, type in the line number.
(Window: none. Also available in: Toolbar, Popup Tools.)
Marks the current cursor position as a returning point or a starting point for a selection.
Choose the position to mark, then tap Mark Position.
(Window: none. Also available in: Toolbar, Popup Tools.)
Jumps between the current cursor position and a previously marked position.
Mark a position as described under Mark Position. Then after having placed the cursor in an other part of the document, tap Jump Between.
* If no position is marked, Jump Between jumps top of the document.
* As the jump is about to be made, the current cursor position and the marked position swap places, so that a second tap on Jump Between will make the cursor return to it's original position.
(Window: none. Also available in: Toolbar, Popup Tools.)
Selects the text between the cursor and the mark.
Mark a position to be the starting point of the selection. Then place the cursor at the ending point of the same selection, and tap Select Between. See Menu/Edit/Mark Position for more details.
(Window: Keyboard.)
Opens the inbuilt Keyboard window.
* SrcEdit's way of presenting text without fields does not allow scrolling though the text using Keyboard. Only one line is editable at the time.
(Window: Preferences.)
Here are some options which affects the basic function of SrcEdit.
Only two buttons: The Standard system font button, and the Resource font button, and yet an endless list of fonts to choose from. The Standard system font needs no further explanation, but the Resource font does.
* SrcEdit also supports FontHack for OS<5.0.
Resource Fonts are resources residing inside the .prc files of many programs. SrcEdit can now make use of Resource Fonts copied from almost any program and copied into the optional SrcEditSkin file.
How to Install Resource Fonts
- Use BIRD or RsrcEdit to copy your favorite Resource Font from the program of your choice.
- Open the SrcEditSkin file and paste the Resource Font into it.
- Change the name to "nfnt 1001" if it is a Hi Res font, and to "NFNT 1000" if it is a Low Res font.
- Open SrcEdit and choose Resource under
Menu/Options/Preferences-Font
* If no Resource Font is found in the SrcEditSkin file or if no SrcEditSkin file is found, SrcEdit will use the built-in Resource Font.
1. Selects which language Keyword set and which comment type is to be colored.
2. Alters the function of Menu/Options/Auto complete so that it besides: "", ' ', also auto completes (), [], and {} in C-mode; < > in HTML-mode, and (), and [] in ASM-mode.
3. Decides what Comment indicators are to be inserted by Menu/Tools/Comment, and deleted by Menu/Tools/Uncomment.
SrcEdit normally makes the selection automatically by looking at the file extension: .c and .h for C; .htm and .html for HTML; and .asm and .inc for ASM. If no file extension is used, or if it is needed to override the automatic selection, a manual selection can be made here.
Choose:
- C--to use C-language keywords.
- HTML--to use Hypertext Markup Language keywords.
- ASM--to use 68k Assembly language keywords.
* If no valid file extension is found, C-mode is default.
* The keywords are a part of the source code color scheme and are therefore colored if Color/Grayscale is checked. See Color/Grayscale-Customize.
* See Auto Complete for details of function and configuration.
Makes it possible to configure hardware buttons for scrolling sideways.
Check this option and choose hardware buttons for scrolling Left and Right.
* Useful for devices without 5-way navigator, or if the 5-way navigator is set on Moving cursor. See Menu/Options/Navigator.
Enables the source code color scheme.
* SrcEdit works somewhat slower with this option set.
Takes you to the Color Setup window.
Comment Lines
The number of lines SrcEdit will look upwards for is a starting "/*" comment.
* Valid in C-Mode only.
(Window: Color Setup.)
How to customize the colors
Tap on the Customizable colors dropdown and choose one of the three list options: Source colors, Databases in lists, and Miscellaneous. Each of these contains another list of the items to setup.
Source Colors
To Set the Colors of: Text, Keywords, Comments, Strings, Characters, Values, Parenthesis, Brackets, and Operators.
Databases in Lists
To set the colors of: Locked DB, Masked DB, and Categories 1 to 15.
Locked DB: Databases set as Read Only. These files also marked with a padlock. See Menu/File/Info.
Masked DB: Databases set as Secret either by the operating system or in Menu/File/Info.
Category: Categories are used in the Menu/File/Open, where files belonging to a specific category will be displayed in the color chosen here.
* To set a file's category, see Menu/File/Info.
Miscellaneous
To set the colors of the Background
After having tapped on an item, it's just to choose a color according to your taste.
The Default Button
Restores all values to SrcEdit original color scheme.
(Window: Toolbar Options.)
Shows the functions linked to the Toolbar icons, and reconfigures them.
To View an Icon's Function
Tap on the icon to view, and the function linked to it will show on the line below.
To Reconfigure an Icon's Function
After having tapped on an icon, tap on the drop down list and choose a new function to link with the icon.
(Window: Tabulator Options.)
Defines SrcEdit's behavior when entering a tab character.
To Use Tab Characters as Tabs
All tabs will be displayed as a blank space, Tab size wide.
Check Tab size and specify the preferred tab size in lowres pixels.
To Use Spaces Instead of Tabs.
When entering a tab, this option substitutes the tab character with a number of spaces.
Check Spaces and specify the preferred number of spaces to use.
* The auto indent function in Menu/Options/Auto Complete will use the option chosen here to indent the lines.
(Window: Auto Complete Options.)
Auto Completion
If checked SrcEdit will in all modes automatically type in the matched par of: "", ' '.
In addition C-mode also auto completes: (), [], {}, HTML-mode: < >, and ASM-mode: (), [].
* See Menu/Options/Preferences-Mode for more details.
Auto Indent After Curly Brace
When a "{" or a ")" is entered, SrcEdit will add one indent level to the following line placing the cursor at the new position.
When a "}" is entered on an empty line, with a following linefeed, SrcEdit will shift the characters on that line one tab position to the left, placing the cursor on the next line.
* If this option is checked, auto completion of "{" is disabled.
* Only available in C-mode.
* This option use tabulators as specified in Meny/Options/Tabulator.
(Window: Navigator Options.)
Sets the desired function of the up, down, left and right buttons.
Scrolling Screen
Scrolls one page up or down if possible, and left or right in steps of one character position.
* Leaves the cursor in its position.
Moving Cursor
Moves the cursor one line up or down if possible, and left or right in steps of one character position.
* Only available on devices with 5-way navigator!
(Window: Function Bookmk Options. A C-mode function.)
Specifies how thorough the function should be when collecting and presenting the function bookmarks. Functions that are completely commented are displayed in the color used for comments. See Menu/Options/Preferences.
Sort Ascending
If checked, the list will be sorted in ascending order.
* By default the functions are presented in the order they appear in the document.
Extra Aware
Uses an advanced search procedure to make the list of functions reliable.
* With this option checked, the Function bookmk popup will take longer time to appear.
* If this option is not checked, the list may occasionally contain false functions.
Show Commented
Enables display of commented functions.
* This option is only available when Extra Aware is checked.
Commented Last
Displays all commented functions separated at the end of the list.
* This option is only available when Extra Aware and Show Commented are checked.
(Window: Keyboard Support.)
Sets what keyboard is to be used.
The keyboard support in SrcEdit is mostly about cursor key navigation: the ability to use Shift to select, Ctrl to move word by word, Cmd to larger amounts, Del to delete the character to the right, Tab to indent selected lines, Shift-Tab to un-indent selected lines, etc.
The keyboards in the list below are linked to the Keyboard Appendix which shows what functionality is implemented, what keys combinations you have to press, and what behaviour you should expect from SrcEdit. The goal has been to mimic (as much as possible) the behaviour of mainstream Windows editors, such as Notepad, TextPad, SourceEdit, etc.
The following keyboards are supported at the moment:
(Window: Popup. A C-mode function. Also available in: Toolbar, Popup tools.)
Helps to find and write a function name.
Place the cursor after at least the first letter in the function name you want to find. Tapping "Keywd complete" brings up a list of functions contained in OnBoardHeader.h (see the OnBoard Suit's user's manual) all starting with the letter or letters immediately to the left of the cursor.
(Window: none. A C-mode function. Also available in: Toolbar, Popup Tools.)
Header Parameters fills in the function parameters found in OnBoardHeader.h for a given function.
Place the cursor immediately to the right of the function name, and tap on Header Params
* Long parameter lists will span over multiple lines.
(Window: Popup. A C-mode function. Also available in: Toolbar, Popup Tools.)
Function Bookmarks is a list of the functions contained in the opened source file, helping you to navigate quickly in your code.
Tap Function Bookmk, choose the function you want to jump to, and tap on it.
* To configurate, see Menu/Option/Function Bookmk.
(Window: none. Also available in: Toolbar, Popup Tools.)
Automatically turns text or code into C-language, HTML, or 68k ASM comments depending on which Mode is chosen.
* See Menu/Options/Preferences-Mode.
How To Comment
One Line
Comment indicator: C-mode "//", HTML-mode "<!-- ... -->", 68k ASM ";".
Select the whole line you want to turn into a comment before tapping on Comment.
* To select a whole line, triple tap on it.
The End of a Line
Comment indicator: C-mode "//", HTML-mode "<!-- ... -->", 68k ASM ";".
Select the end of a line and tap on Comment.
* SrcEdit disregards any ending white spaces.
A Block of Text in the Middle of a Line
Comment indicator: C-mode "/* ... */", HTML-mode "<!-- ... -->".
Make a selection anywhere on a line, except the end. Tap on Comment.
Multiple Lines
Comment indicator: C-mode "/* ... */", HTML-mode "<!-- ... -->", 68k ASM ";".
Select the lines you want to turn into comments, before tapping on Comment.
* Only the selected text will be a "Comment".
(Window: none. Also available in: Toolbar, Popup Tools.)
Removes the comment characters.
How To Uncomment
One Line
Select some of the commented characters and tap on Uncomment.
* Only one selected character is necessary.
* You May also Uncomment multiple whole line comments.
Multiple Lines
Select all commented characters before tapping on this menu item.
* All the commented characters should be selected, but not any of the comment indicators (/* or */).
(Window: none.)
Launches a compiler depending on what extension the opened source DOC has.
Launches:
- OnBoardC if the extension is ".c" or ".h"
- OnBoard Assembler if the extension is ".asm" or ".inc
- PP Compiler if the extension is ".pas"
- iziBasic if the extension is ".ibas"
- Plua if the extension is ".plua"
(Window: About SrcEdit.)
Here you find information about SrcEdit's version number, licensing, and bug reporting.
The Toolbar consists of eleven icons located at the bottom of the main form, each configurable to hold the function of your choice. See Menu/Options/Toolbar to configure the Toolbar.
Available functions:
Popup Tools is really two different popup lists on the same icon. One appears if a text is selected when the icon it is assigned to is tapped, and the other one when no text is selected.
Popup tools when there is a text selection:
- Cut
- Copy
- Paste
- Find/Replace
- Comment
- Uncomment
- Shift Left
- Shift Right
- Uppercase
Transforms all characters to uppercase.
Select the text to transform, then tap on Uppercase.
- Lowercase
Transforms all characters to lowercase.
Select the text to transform, then tap on Lowercase.
- Toggle Case
Changes lowercase characters to uppercase characters and uppercase characters to lowercase characters.
Select the text to toggle the case on, then tap on Toggle Case.
- Reverse
Reverses a text.
Select the text to reverse, then tap on Reverse.
Popup tools when there isn't any text selection:
Normal method: Double tap on one of the curly brace and the code between the curly brace tapped on and the matching one will be selected.
Using the 5-way navigator: Place the cursor immediately before one of the curly braces and double click on the 5-way navigator's center button.
Normal method: Double tap on one of the parenthesis and the function parameters between the parenthesis tapped on and the matching one will be selected.
Using the 5-way navigator: Place the cursor immediately before one of the parenthesis and double click on the 5-way navigator's center button.
Makes it possible to resize an existing selection.
To lengthen a selection: Having made a selection, make a grafitti "Shift" as if to write an uppercase character, then tap on the point in the text before or after the selecion to which the selection should be extended.
To shorten a selection: Having made a selection, make a grafitti shift as if to write an uppercase character, then tap on the point inside the selection to which the selection should be shortened.
* The shortening of a selection only works at the end of a selection at the moment.
* To make a second resize on the same selection, it's necessary to unshift and then make a new shift before trying to resize. Only one resize per shift is permitted.
A SrcEdit skin is a resource database. It must have creator ID "LedX", and be of type "SKIN". SrcEdit will open this database at startup and use bitmap resources found therein. There can only be one skin database installed on a device.
Bitmap Resources
A SrcEdit Skin database should contain eleven bitmap resources to be displayed as the buttons array at the bottom of the main application form (the edit screen), in the Configure Toolbar window and in the system's Menu Command Bar. These resources must be standard PalmOS bitmaps of type "Tbmp". The resource id's of these bitmaps must be as follows:
ID - Default Function
-------------------------
1040 - Cut
1041 - Copy
1042 - Paste
1043 - Undo
1044 - Search/Replace
1045 - Search Again
1046 - Launch Compiler
1047 - Shift Left
1048 - Shift Right
1049 - Keyword Complete
1050 - Function Bookmarks
Dimensions of these bitmaps should be: width 11 pixels, height 13 pixels.
Every resource must contain at least one Single-Density (Lo-Res) bitmap. Dimensions of Double-Density (Hi-Res) bitmaps, if you intend on adding such, must be twice that of a Single-Density - that is 22 pixels width x 26 pixels height.
Bitmap Editors
This is a list of PalmOS applications which might be used to create SrcEdit skins. This list is by no means full - feel free to extend it.
Bird - a new freeware resource editor. Edits Single- and Double-Density bitmaps as well as icons.
TbmpEdit - edits both, Single- and Double-Density bitmaps, but runs only on OS 5 devices.
RsrcEdit - edits only Single-Density bitmaps.
How to Install Resource Fonts
A skin file can also contain Resource Fonts. See Menu/Options/Preferences-Font for more information.
Great care has been taken to catch all the bugs in SrcEdit. But since no program ever has been 100% bug free, we have to alert you: The few that probably are left are the most difficult once to catch!
Please help us find them. If you see one, place a bug report at
OnBoardC's site.
We would like to thank everybody who in some way or another has participated in the development of this project. Thank you very, very much!
© John Wilund and Peter Thorstenson 2005
This document is released under
GNU Free Documentation License (FDL).
|