1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package graphical;
import java.io.File;
import java.io.RandomAccessFile;
import java.util.ArrayList;
import java.util.Enumeration;
/**
Helper class to give a simple API to read/write windows like ini files
*/
/* public */ // is only need, if we need this class outside package convwatch
public class IniFile implements Enumeration<String>
{
/**
* internal representation of the ini file content.
* Problem, if ini file changed why other write something difference, we don't realise this.
*/
private String m_sFilename;
private ArrayList<String> m_aList;
private boolean m_bListContainUnsavedChanges = false;
private int m_aEnumerationPos = 0;
/**
open a ini file by its name
@param _sFilename string a filename, if the file doesn't exist, a new empty ini file will create.
write back to disk only if there are really changes.
*/
public IniFile(String _sFilename)
{
m_sFilename = _sFilename;
m_aList = loadLines();
m_aEnumerationPos = findNextSection(0);
}
public void insertFirstComment(String[] _aList)
{
if (m_aList.isEmpty())
{
// can only insert if there is nothing else already in the ini file
for (int i = 0; i < _aList.length; i++)
{
m_aList.add(_aList[i]);
}
}
}
private ArrayList<String> loadLines()
{
File aFile = new File(m_sFilename);
ArrayList<String> aLines = new ArrayList<String>();
if (!aFile.exists())
{
return aLines;
}
RandomAccessFile aReader = null;
try
{
aReader = new RandomAccessFile(aFile, "r");
String aLine = "";
while (aLine != null)
{
aLine = aReader.readLine();
if (aLine != null && aLine.length() > 0)
{
aLines.add(aLine);
}
}
}
catch (java.io.FileNotFoundException fne)
{
GlobalLogWriter.println("couldn't open file " + m_sFilename);
GlobalLogWriter.println("Message: " + fne.getMessage());
}
catch (java.io.IOException ie)
{
GlobalLogWriter.println("Exception occurs while reading from file " + m_sFilename);
GlobalLogWriter.println("Message: " + ie.getMessage());
}
try
{
aReader.close();
}
catch (java.io.IOException ie)
{
GlobalLogWriter.println("Couldn't close file " + m_sFilename);
GlobalLogWriter.println("Message: " + ie.getMessage());
}
return aLines;
}
/**
* @return true, if the ini file contain some readable data
*/
public boolean is()
{
return m_aList.size() > 1;
}
/**
* Check if a given Section and Key exists in the ini file
* @return true if the given Section, Key exists, now you can get the value
*/
public boolean hasValue(String _sSectionName, String _sKey)
{
int n = findKey(_sSectionName, _sKey);
if (n > 0)
{
return true;
}
return false;
}
private boolean isRemark(String _sLine)
{
if (((_sLine.length() < 2)) ||
(_sLine.startsWith("#")) ||
(_sLine.startsWith(";")))
{
return true;
}
return false;
}
private String getItem(int i)
{
return m_aList.get(i);
}
private String buildSectionName(String _sSectionName)
{
String sFindSection = "[" + _sSectionName + "]";
return sFindSection;
}
private String sectionToString(String _sSectionName)
{
String sKeyName = _sSectionName;
if (sKeyName.startsWith("[") &&
sKeyName.endsWith("]"))
{
sKeyName = sKeyName.substring(1, sKeyName.length() - 1);
}
return sKeyName;
}
private String toLowerIfNeed(String _sName)
{
return _sName.toLowerCase();
}
// return the number where this section starts
private int findSection(String _sSection)
{
String sFindSection = toLowerIfNeed(buildSectionName(_sSection));
// ----------- find _sSection ---------------
int i;
for (i = 0; i < m_aList.size(); i++)
{
String sLine = toLowerIfNeed(getItem(i).trim());
if (isRemark(sLine))
{
continue;
}
if (sFindSection.equals("[]"))
{
// special case, empty Section.
return i - 1;
}
if (sLine.startsWith(sFindSection))
{
return i;
}
}
return -1;
}
/**
* Checks if a given section exists in the ini file
* @return true if the given _sSection was found
*/
public boolean hasSection(String _sSection)
{
int i = findSection(_sSection);
if (i == -1)
{
return false;
}
return true;
}
// return the line number, where the key is found.
private int findKey(String _sSection, String _sKey)
{
int i = findSection(_sSection);
if (i == -1)
{
// Section not found, therefore the value can't exist
return -1;
}
return findKeyFromKnownSection(i, _sKey);
}
// i must be the index in the list, where the well known section starts
private int findKeyFromKnownSection(int _nSectionIndex, String _sKey)
{
_sKey = toLowerIfNeed(_sKey);
for (int j = _nSectionIndex + 1; j < m_aList.size(); j++)
{
String sLine = getItem(j).trim();
if (isRemark(sLine))
{
continue;
}
if (sLine.startsWith("[") )
{
// TODO: due to the fact we would like to insert an empty line before new sections
// TODO: we should check if we are in an empty line and if, go back one line.
// found end.
break;
}
int nEqual = sLine.indexOf('=');
if (nEqual >= 0)
{
String sKey = toLowerIfNeed(sLine.substring(0, nEqual).trim());
if (sKey.equals(_sKey))
{
return j;
}
}
}
return -1;
}
// i must be the index in the list, where the well known section starts
private int findLastKnownKeyIndex(int _nSectionIndex, String _sKey)
{
_sKey = toLowerIfNeed(_sKey);
int i = _nSectionIndex + 1;
for (int j = i; j < m_aList.size(); j++)
{
String sLine = getItem(j).trim();
if (isRemark(sLine))
{
continue;
}
if (sLine.startsWith("["))
{
// found end.
return j;
}
int nEqual = sLine.indexOf('=');
if (nEqual >= 0)
{
String sKey = toLowerIfNeed(sLine.substring(0, nEqual).trim());
if (sKey.equals(_sKey))
{
return j;
}
}
}
return i;
}
private String getValue(int _nIndex)
{
String sLine = getItem(_nIndex).trim();
if (isRemark(sLine))
{
return "";
}
int nEqual = sLine.indexOf('=');
if (nEqual >= 0)
{
String sValue = sLine.substring(nEqual + 1).trim();
return sValue;
}
return "";
}
/**
@param _sSection string
@param _sKey string
@return the value found in the inifile which is given by the section and key parameter
*/
public String getValue(String _sSection, String _sKey)
{
String sValue = "";
int nCurrentPosition = findKey(_sSection, _sKey);
if (nCurrentPosition == -1)
{
// Section not found, therefore the value can't exist
return "";
}
// m_sOldKey = _sKey;
sValue = getValue(nCurrentPosition);
return sValue;
}
/**
* Returns the value at Section, Key converted to an integer
* Check with hasValue(Section, Key) to check before you get into trouble.
* @param _nDefault if there is a problem, key not found... this value will return
*/
public int getIntValue(String _sSection, String _sKey, int _nDefault)
{
String sValue = getValue(_sSection, _sKey);
int nValue = _nDefault;
if (sValue.length() > 0)
{
try
{
nValue = Integer.parseInt(sValue);
}
catch (java.lang.NumberFormatException e)
{
GlobalLogWriter.println("IniFile.getIntValue(): Caught a number format exception, return the default value.");
}
}
return nValue;
}
public void close()
{
store();
}
/**
write back the ini file to the disk, only if there exist changes
* @deprecated use close() instead!
*/
// TODO: make private
private void store()
{
if (!m_bListContainUnsavedChanges)
{
// nothing has changed, so no need to store
return;
}
File aFile = new File(m_sFilename);
if (aFile.exists())
{
// TODO: little bit unsafe here, first rename, after write is complete, delete the old.
aFile.delete();
if (aFile.exists())
{
GlobalLogWriter.println("Couldn't delete the file " + m_sFilename);
return;
}
}
try
{
RandomAccessFile aWriter = new RandomAccessFile(aFile, "rw");
for (int i = 0; i < m_aList.size(); i++)
{
String sLine = getItem(i);
if (sLine.startsWith("["))
{
// write an extra empty line before next section.
aWriter.writeByte('\n');
}
aWriter.writeBytes(sLine);
aWriter.writeByte('\n');
}
aWriter.close();
}
catch (java.io.FileNotFoundException fne)
{
GlobalLogWriter.println("couldn't open file for writing " + m_sFilename);
GlobalLogWriter.println("Message: " + fne.getMessage());
}
catch (java.io.IOException ie)
{
GlobalLogWriter.println("Exception occurs while writing to file " + m_sFilename);
GlobalLogWriter.println("Message: " + ie.getMessage());
}
}
public void insertValue(String _sSection, String _sKey, int _nValue)
{
insertValue(_sSection, _sKey, String.valueOf(_nValue));
}
/**
insert a value
there are 3 cases
1. section doesn't exist, goto end and insert a new section, insert a new key value pair
2. section exist but key not, search section, search key, if key is -1 get last known key position and insert new key value pair there
3. section exist and key exist, remove the old key and insert the key value pair at the same position
*/
public void insertValue(String _sSection, String _sKey, String _sValue)
{
int i = findSection(_sSection);
if (i == -1)
{
// case 1: section doesn't exist
String sFindSection = buildSectionName(_sSection);
// TODO: before create a new Section, insert a empty line
m_aList.add(sFindSection);
if (_sKey.length() > 0)
{
String sKeyValuePair = _sKey + "=" + _sValue;
m_aList.add(sKeyValuePair);
}
m_bListContainUnsavedChanges = true;
return;
}
int j = findKeyFromKnownSection(i, _sKey);
if (j == -1)
{
// case 2: section exist, but not the key
j = findLastKnownKeyIndex(i, _sKey);
if (_sKey.length() > 0)
{
String sKeyValuePair = _sKey + "=" + _sValue;
m_aList.add(j, sKeyValuePair);
m_bListContainUnsavedChanges = true;
}
return;
}
else
{
// case 3: section exist, and also the key
String sKeyValuePair = _sKey + "=" + _sValue;
m_aList.set(j, sKeyValuePair);
m_bListContainUnsavedChanges = true;
}
}
public void removeSection(String _sSectionToRemove)
{
// first, search for the name
int i = findSection(_sSectionToRemove);
if (i == -1)
{
// Section to remove not found, do nothing.
return;
}
// second, find the next section
int j = findNextSection(i + 1);
if (j == -1)
{
// if we are at the end, use size() as second section
j = m_aList.size();
}
// remove all between first and second section
for (int k = i; k < j; k++)
{
m_aList.remove(i);
}
// mark the list as changed
m_bListContainUnsavedChanges = true;
}
/**
* some tests for this class
*/
/**
* Enumeration Interface
* @return true, if there are more Key values
*/
public boolean hasMoreElements()
{
if (m_aEnumerationPos >= 0 &&
m_aEnumerationPos < m_aList.size())
{
return true;
}
return false;
}
/**
* Find the next line, which starts with '['
* @param i start position
* @return the line where '[' found or -1
*/
private int findNextSection(int i)
{
if (i >= 0)
{
while (i < m_aList.size())
{
String sLine = m_aList.get(i);
if (sLine.startsWith("["))
{
return i;
}
i++;
}
}
return -1;
}
/**
* Enumeration Interface
* @return a key without the enveloped '[' ']'
*/
public String nextElement()
{
int nLineWithSection = findNextSection(m_aEnumerationPos);
if (nLineWithSection != -1)
{
String sSection = m_aList.get(nLineWithSection);
m_aEnumerationPos = findNextSection(nLineWithSection + 1);
sSection = sectionToString(sSection);
return sSection;
}
else
{
m_aEnumerationPos = m_aList.size();
}
return null;
}
/**
* Helper to count the occurrence of Sections
* @return returns the count of '^['.*']$' Elements
*/
public int getElementCount()
{
int nCount = 0;
int nPosition = 0;
while ((nPosition = findNextSection(nPosition)) != -1)
{
nCount++;
nPosition++;
}
return nCount;
}
}
|