24 | * Instances of this class are created only by CharsetDetectors.
25 | *
26 | * Note: this class has a natural ordering that is inconsistent with equals.
27 | * The natural ordering is based on the match confidence value.
28 | *
29 | * @stable ICU 3.4
30 | */
31 | public class CharsetMatch implements Comparable {
32 |
33 |
34 | /**
35 | * Create a java.io.Reader for reading the Unicode character data corresponding
36 | * to the original byte data supplied to the Charset detect operation.
37 | *
38 | * CAUTION: if the source of the byte data was an InputStream, a Reader
39 | * can be created for only one matching char set using this method. If more
40 | * than one charset needs to be tried, the caller will need to reset
41 | * the InputStream and create InputStreamReaders itself, based on the charset name.
42 | *
43 | * @return the Reader for the Unicode character data.
44 | *
45 | * @stable ICU 3.4
46 | */
47 | public Reader getReader() {
48 | InputStream inputStream = fInputStream;
49 |
50 | if (inputStream == null) {
51 | inputStream = new ByteArrayInputStream(fRawInput, 0, fRawLength);
52 | }
53 |
54 | try {
55 | inputStream.reset();
56 | return new InputStreamReader(inputStream, getName());
57 | } catch (IOException e) {
58 | return null;
59 | }
60 | }
61 |
62 | /**
63 | * Create a Java String from Unicode character data corresponding
64 | * to the original byte data supplied to the Charset detect operation.
65 | *
66 | * @return a String created from the converted input data.
67 | *
68 | * @stable ICU 3.4
69 | */
70 | public String getString() throws java.io.IOException {
71 | return getString(-1);
72 |
73 | }
74 |
75 | /**
76 | * Create a Java String from Unicode character data corresponding
77 | * to the original byte data supplied to the Charset detect operation.
78 | * The length of the returned string is limited to the specified size;
79 | * the string will be trunctated to this length if necessary. A limit value of
80 | * zero or less is ignored, and treated as no limit.
81 | *
82 | * @param maxLength The maximum length of the String to be created when the
83 | * source of the data is an input stream, or -1 for
84 | * unlimited length.
85 | * @return a String created from the converted input data.
86 | *
87 | * @stable ICU 3.4
88 | */
89 | public String getString(int maxLength) throws java.io.IOException {
90 | String result = null;
91 | if (fInputStream != null) {
92 | StringBuilder sb = new StringBuilder();
93 | char[] buffer = new char[1024];
94 | Reader reader = getReader();
95 | int max = maxLength < 0? Integer.MAX_VALUE : maxLength;
96 | int bytesRead = 0;
97 |
98 | while ((bytesRead = reader.read(buffer, 0, Math.min(max, 1024))) >= 0) {
99 | sb.append(buffer, 0, bytesRead);
100 | max -= bytesRead;
101 | }
102 |
103 | reader.close();
104 |
105 | return sb.toString();
106 | } else {
107 | String name = getName();
108 | /*
109 | * getName() may return a name with a suffix 'rtl' or 'ltr'. This cannot
110 | * be used to open a charset (e.g. IBM424_rtl). The ending '_rtl' or 'ltr'
111 | * should be stripped off before creating the string.
112 | */
113 | int startSuffix = name.indexOf("_rtl") < 0 ? name.indexOf("_ltr") : name.indexOf("_rtl");
114 | if (startSuffix > 0) {
115 | name = name.substring(0, startSuffix);
116 | }
117 | result = new String(fRawInput, name);
118 | }
119 | return result;
120 |
121 | }
122 |
123 | /**
124 | * Get an indication of the confidence in the charset detected.
125 | * Confidence values range from 0-100, with larger numbers indicating
126 | * a better match of the input data to the characteristics of the
127 | * charset.
128 | *
129 | * @return the confidence in the charset match
130 | *
131 | * @stable ICU 3.4
132 | */
133 | public int getConfidence() {
134 | return fConfidence;
135 | }
136 |
137 | /**
138 | * Get the name of the detected charset.
139 | * The name will be one that can be used with other APIs on the
140 | * platform that accept charset names. It is the "Canonical name"
141 | * as defined by the class java.nio.charset.Charset; for
142 | * charsets that are registered with the IANA charset registry,
143 | * this is the MIME-preferred registerd name.
144 | *
145 | * @see java.nio.charset.Charset
146 | * @see java.io.InputStreamReader
147 | *
148 | * @return The name of the charset.
149 | *
150 | * @stable ICU 3.4
151 | */
152 | public String getName() {
153 | return fCharsetName;
154 | }
155 |
156 | /**
157 | * Get the ISO code for the language of the detected charset.
158 | *
159 | * @return The ISO code for the language or null if the language cannot be determined.
160 | *
161 | * @stable ICU 3.4
162 | */
163 | public String getLanguage() {
164 | return fLang;
165 | }
166 |
167 | /**
168 | * Compare to other CharsetMatch objects.
169 | * Comparison is based on the match confidence value, which
170 | * allows CharsetDetector.detectAll() to order its results.
171 | *
172 | * @param other the CharsetMatch object to compare against.
173 | * @return a negative integer, zero, or a positive integer as the
174 | * confidence level of this CharsetMatch
175 | * is less than, equal to, or greater than that of
176 | * the argument.
177 | * @throws ClassCastException if the argument is not a CharsetMatch.
178 | * @stable ICU 4.4
179 | */
180 | @Override
181 | public int compareTo (CharsetMatch other) {
182 | int compareResult = 0;
183 | if (this.fConfidence > other.fConfidence) {
184 | compareResult = 1;
185 | } else if (this.fConfidence < other.fConfidence) {
186 | compareResult = -1;
187 | }
188 | return compareResult;
189 | }
190 |
191 | /*
192 | * Constructor. Implementation internal
193 | */
194 | CharsetMatch(CharsetDetector det, CharsetRecognizer rec, int conf) {
195 | fConfidence = conf;
196 |
197 | // The references to the original application input data must be copied out
198 | // of the charset recognizer to here, in case the application resets the
199 | // recognizer before using this CharsetMatch.
200 | if (det.fInputStream == null) {
201 | // We only want the existing input byte data if it came straight from the user,
202 | // not if is just the head of a stream.
203 | fRawInput = det.fRawInput;
204 | fRawLength = det.fRawLength;
205 | }
206 | fInputStream = det.fInputStream;
207 | fCharsetName = rec.getName();
208 | fLang = rec.getLanguage();
209 | }
210 |
211 | /*
212 | * Constructor. Implementation internal
213 | */
214 | CharsetMatch(CharsetDetector det, CharsetRecognizer rec, int conf, String csName, String lang) {
215 | fConfidence = conf;
216 |
217 | // The references to the original application input data must be copied out
218 | // of the charset recognizer to here, in case the application resets the
219 | // recognizer before using this CharsetMatch.
220 | if (det.fInputStream == null) {
221 | // We only want the existing input byte data if it came straight from the user,
222 | // not if is just the head of a stream.
223 | fRawInput = det.fRawInput;
224 | fRawLength = det.fRawLength;
225 | }
226 | fInputStream = det.fInputStream;
227 | fCharsetName = csName;
228 | fLang = lang;
229 | }
230 |
231 |
232 | //
233 | // Private Data
234 | //
235 | private int fConfidence;
236 | private byte[] fRawInput = null; // Original, untouched input bytes.
237 | // If user gave us a byte array, this is it.
238 | private int fRawLength; // Length of data in fRawInput array.
239 |
240 | private InputStream fInputStream = null; // User's input stream, or null if the user
241 | // gave us a byte array.
242 |
243 | private String fCharsetName; // The name of the charset this CharsetMatch
244 | // represents. Filled in by the recognizer.
245 | private String fLang; // The language, if one was determined by
246 | // the recognizer during the detect operation.
247 | }
248 |
--------------------------------------------------------------------------------
/src/main/assets/help.md:
--------------------------------------------------------------------------------
1 | # Notes
2 | ---
3 |
4 | Android notebook
5 |
6 | * Notes saved in text files
7 | * Use markdown formatting
8 | * Optional new note template
9 | * Optional new note file name template
10 | * Display media
11 | * Display [OpenStreetMap](https://www.openstreetmap.org) maps
12 | * Print notes
13 | * Share notes
14 | * Add date and time
15 | * Add media from media providers
16 | * Receive media from other apps
17 | * Receive geo uris from other apps
18 | * Incremental search of notes
19 | * Dark or light theme for editing
20 | * Shortcut for new notes
21 | * Optional CSS styles
22 | * Optional JavaScript scripts
23 | * Back up notes to a zip file
24 | * Optional edit cursor position control
25 |
26 | ## Toolbar
27 |
28 | The toolbar items which won’t necessarily all appear at once:
29 |
30 | * **New** – Start a new note
31 | * **Save** – Save note
32 | * **Open** – Open an existing note
33 | * **Search** – incremental search of note
34 |
35 | And on the menu:
36 |
37 | * **Find all** – Find all notes containing search text
38 | * **Open recent** – Pop up a list of recent files
39 | * **Clear list** – Clear list of recent files
40 | * **Print** – Print note
41 | * **Share** – Share note
42 | * **Save as** – Save note in another file
43 | * **Add date** – Add the current date and time
44 | * **Add media** – Add media from media providers
45 | * **Edit styles** – show an editor to edit the custom styles
46 | * **Edit script** – show an editor to edit custom javascript
47 | * **Backup** – backup notes to a zip file
48 | * **Settings** – Show the settings
49 |
50 | ## Help
51 | You may put a link `[Help](file:///android_asset/help.md)` to the help
52 | file in the app assets in a note. The file will be loaded and may be
53 | saved using the **Save as** menu entry.
54 |
55 | ## Double tap
56 | In the formatted view a double tap on the screen will switch to the
57 | edit view in approximately the same position in the markdown text. The
58 | accuracy is dependent on the text formatting and media in the note.
59 |
60 | ## Editing
61 | In the formatted view the **Edit** button floating above the page
62 | allows editing notes. The **Accept** button restores the formatted
63 | view. A long touch on the button hides it until the device is rotated
64 | or a long touch on the page.
65 |
66 | See [Markdown](https://daringfireball.net/projects/markdown) for
67 | markdown syntax.
68 |
69 | ## Scrolling
70 | Scrolling the page up will temporarily hide the floating
71 | button. Scrolling down restores it.
72 |
73 | ## Search
74 | You may search notes, the search will update as text is entered into
75 | the search field. Use the search widget or keyboard action button to
76 | find the next match. To find and edit text, search in the markdown
77 | view, and then double tap where you want to edit. This will switch to
78 | the edit view at about the right place.
79 |
80 | ## Find all
81 | You may find all notes that contain the current search text. This menu
82 | item will only appear while the search widget is active. A dialog will
83 | pop up with a list of matching notes. Touch an entry to open that
84 | note. You may repeat this or refine the search text to find the
85 | desired note.
86 |
87 | ## Keyboard shortcuts
88 | When using an external keyboard, some keyboard shortcuts are
89 | implemented:
90 | * Ctrl+D – Done
91 | * Ctrl+E – Edit
92 | * Ctrl+N – New file
93 | * Ctrl+O – Open file
94 | * Ctrl+S – Save file
95 | * Ctrl+Shift+S – Save as
96 |
97 | ## Template
98 | You may use a note template. If a template is set it will be copied to
99 | a new note. A date code – `<>` may be inserted into the
100 | template which will be converted into the current date and
101 | time. Alternatively a date pattern may be added to the code –
102 | `<>` for a custom date format. See
103 | [here](https://developer.android.com/reference/java/text/SimpleDateFormat#date-and-time-patterns) for the pattern documentation.
104 |
105 | ## Name template
106 | You may use a template for new note names. If a template is set it
107 | will be used for the name of new notes. A date code – `<>`
108 | may be inserted into the template which will be converted into the
109 | current date and time. This will default to `yyyy/MM/dd-HHmmss`, which
110 | will expand to `2022/02/20-113052`, so `<>.md` will give
111 | `2022/02/20-113052.md`. This gives a hierarchical folder sturcture
112 | similar to my [Diary](https://github.com/billthefarmer/diary)
113 | app. Alternatively you may use your own date pattern for a custom
114 | name, as above.
115 |
116 | ## Text
117 | You may receive text clips from another app. The text will be added at
118 | the current cursor position, or in a new note if no note is open.
119 |
120 | ## Media
121 | You may store media in the note storage folder and reference them in
122 | notes, so markdown text `` will display `cat.jpg`
123 | stored in the note folder. You may either add media from media
124 | providers like file managers or image managers or receive media sent
125 | by other apps. Media added will be added at the current cursor
126 | position. Media sent by other apps will be added at the current cursor
127 | position, or in a new note if no note is open. Content URIs
128 | (`content://`) sent by some media providers and apps will be resolved
129 | to file URIs (`file:///`) if possible. Media will be added using
130 | markdown image syntax (`![]()`), which will be parsed into
131 | an HTML5 media player, text clips will be added as above, URLs will be
132 | added as a link. Media added from removable SD cards not part of the
133 | device storage may work but may not be persistent and is not supported.
134 |
135 | ## Markdown
136 | Notes supports several markdown extensions including autolink, tables
137 | using vertical bar characters, heading anchor, underlining using
138 | `++underline++`, strikethrough using `~~strike~~`, YAML front matter,
139 | task lists using `- [x] task #1`, `- [ ] task #2`, superscript using
140 | `^super^`, subscript using `~sub~`.
141 |
142 | ## Task lists
143 | To change the state of check boxes in a task list, switch to the edit
144 | view and tap on the box `[ ]`. The box will change state and the edit
145 | cursor will be where you tapped.
146 |
147 | ## LaTeX
148 | Notes doesn't support [LaTeX](https://en.wikipedia.org/wiki/LaTeX),
149 | but it is possible to use an external site to add LaTeX formatted
150 | images.
151 |
152 | 
153 |
154 | \sum_{i=1}^{n}x_{i}^{2}
155 |
156 | 
157 |
158 | If you don't intend to change the image, you can copy it and use that
159 | instead, which will then work offline.
160 |
161 | ## Svgbob
162 | Notes doesn't support text diagrams, but will display SVG images
163 | produced by an online editor [Svgbob
164 | Editor](https://svgbob-editor.netlify.app/).
165 |
166 | 
167 |
168 | ## Links
169 | You may put external links in notes, so
170 | `[DuckDuckGo](https://duckduckgo.com)` will show a link to
171 | [DuckDuckGo](https://duckduckgo.com). Links will be followed if
172 | touched. Use the back button in the toolbar or the navigation bar to
173 | return to the note. Links to other notes may added as a relative
174 | reference `[AnotherNote](AnotherNote.md)`.
175 |
176 | ## Maps
177 | You may put [OpenStreetMap](https://www.openstreetmap.org) maps in
178 | notes with a geo URI ``. Geo uris received from
179 | other apps will be added at the current cursor position, or in a new
180 | note if no note is open.
181 |
182 | ## Cursor position
183 | You may put a line in a note to control or remember the edit cursor
184 | position. This will not appear in the markdown view. Put `[<]: #` on a
185 | line for the start of an note, `[>]: #` for the end of a note. Put
186 | `[#]: #` for the cursor position to be remembered. There should be no
187 | other text on the line. The current cursor position will be added when
188 | the note is saved `[#]: # (nnn)`. Because notes are only saved if they
189 | are changed, moving the cursor with no other change will not move the
190 | saved position.
191 |
192 | ## Styles
193 | You may add custom styles to the markdown formatting by placing a
194 | `styles.css` file in the `Notes/css` folder, which will replace the
195 | built in styles file which simply limits the width of images to the
196 | page width. Use the built in editor to create a styles file. You must
197 | use the editor `accept` tick button to save the edits.
198 |
199 | **Caution** – There is no such thing as a markdown syntax error, but
200 | syntax errors in a styles file may cause unpredictable results and
201 | affect all notes. See [CSS Tutorial](https://www.w3schools.com/Css).
202 |
203 | You may include the built in styles file with an `@import` statement
204 | `@import "file:///android_asset/styles.css";` or `@import
205 | url("file:///android_asset/styles.css");`, which should be on the
206 | first line.
207 |
208 | ## Javascript
209 | You may add custom javascript to be loaded into all notes by placing a
210 | `script.js` file in the `Notes/js` folder. Use the built in editor to
211 | create a script file. You must use the editor `accept` tick button to
212 | save the edits. Errors in the script will be logged by the
213 | [WebView](https://developer.android.com/reference/android/webkit/WebView)
214 | which displays the page. See [Javascript
215 | tutorial](https://www.w3schools.com/js).
216 |
217 | If you want to use javascript libraries or write a large script it
218 | might be a good idea to use the Google
219 | [Closure Compiler](https://developers.google.com/closure/compiler) to
220 | check and minimise your code. It will handle multiple input files.
221 |
222 | ## Emojies
223 | There is a script,
224 | [emojies.js](https://github.com/billthefarmer/notes/blob/master/data/emojies.js)
225 | in the data folder and a minimised version,
226 | [emojies.min.js](https://github.com/billthefarmer/notes/blob/master/data/emojies.min.js). Either
227 | may be copied to the `script.js` file as above. The script is a work
228 | in progress, it could do with some TLC from an expert.
229 |
230 | ## Backup
231 | You may create a backup of all your notes in a zip file. The file
232 | defaults to the same name as the notes folder, `Notes.zip`, but may be
233 | changed using the dialog, or by using the **Storage** button to save
234 | the backup using the android file manager.
235 |
236 | ## Sync
237 | Android cloud storage apps when last tested appeared not to be capable
238 | of syncing a real storage folder on the device. However
239 | [Syncthing](https://syncthing.net) does just that and can sync your
240 | notes folder with other devices and desktop computers.
241 |
242 | ## Removable SD cards
243 | Android allows removable SD cards to be used like a USB stick or as
244 | part of the device storage. Notes opened using the chooser on a
245 | removable SD card may not save successfully using the save button. Use
246 | the **Save as** menu item and the **Storage** button to save it using
247 | the android file manager. Alternatively use the **Storage** button on
248 | the chooser dialog to open the Note using the android file manager.
249 |
250 | ## Settings
251 | * **Folder** – Change notes storage folder. Caution –
252 | notes, styles and scripts will not be moved
253 | * **New note template** – Set a new note template. Use the
254 | dialog to choose a file.
255 | * **New note name template** – Set a template for new note
256 | names. Use the dialog to choose a name.
257 | * **Browser** – Use browser for external links
258 | * **Theme** – Choose app theme
259 | * **About** – Show app version, licence and credits
260 |
--------------------------------------------------------------------------------