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
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* 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/.
*/
#include <rtl/ustring.hxx>
#include <rtl/strbuf.hxx>
#include <rtl/crc.h>
#include <sal/log.hxx>
#include <cstring>
#include <ctime>
#include <cassert>
#include <vector>
#include <string>
#include <string_view>
#include <po.hxx>
#include <helper.hxx>
/** Container of po entry
Provide all file operations related to LibreOffice specific
po entry and store it's attributes.
*/
class GenPoEntry
{
private:
OStringBuffer m_sExtractCom;
std::vector<OString> m_sReferences;
OString m_sMsgCtxt;
OString m_sMsgId;
OString m_sMsgIdPlural;
OString m_sMsgStr;
std::vector<OString> m_sMsgStrPlural;
bool m_bFuzzy;
bool m_bCFormat;
bool m_bNull;
public:
GenPoEntry();
const std::vector<OString>& getReference() const { return m_sReferences; }
const OString& getMsgCtxt() const { return m_sMsgCtxt; }
const OString& getMsgId() const { return m_sMsgId; }
const OString& getMsgStr() const { return m_sMsgStr; }
bool isFuzzy() const { return m_bFuzzy; }
bool isNull() const { return m_bNull; }
void setExtractCom(std::string_view rExtractCom)
{
m_sExtractCom = rExtractCom;
}
void setReference(const OString& rReference)
{
m_sReferences.push_back(rReference);
}
void setMsgCtxt(const OString& rMsgCtxt)
{
m_sMsgCtxt = rMsgCtxt;
}
void setMsgId(const OString& rMsgId)
{
m_sMsgId = rMsgId;
}
void setMsgStr(const OString& rMsgStr)
{
m_sMsgStr = rMsgStr;
}
void writeToFile(std::ofstream& rOFStream) const;
void readFromFile(std::ifstream& rIFStream);
};
namespace
{
// Convert a normal string to msg/po output string
OString lcl_GenMsgString(std::string_view rString)
{
if ( rString.empty() )
return "\"\""_ostr;
OString sResult =
"\"" +
helper::escapeAll(rString,"\n""\t""\r""\\""\"","\\n""\\t""\\r""\\\\""\\\"") +
"\"";
sal_Int32 nIndex = 0;
while((nIndex=sResult.indexOf("\\n",nIndex))!=-1)
{
if( !sResult.match("\\\\n", nIndex-1) &&
nIndex!=sResult.getLength()-3)
{
sResult = sResult.replaceAt(nIndex,2,"\\n\"\n\"");
}
++nIndex;
}
if ( sResult.indexOf('\n') != -1 )
return "\"\"\n" + sResult;
return sResult;
}
// Convert msg string to normal form
OString lcl_GenNormString(std::string_view rString)
{
return
helper::unEscapeAll(
rString.substr(1,rString.size()-2),
"\\n""\\t""\\r""\\\\""\\\"",
"\n""\t""\r""\\""\"");
}
}
GenPoEntry::GenPoEntry()
: m_bFuzzy( false )
, m_bCFormat( false )
, m_bNull( false )
{
}
void GenPoEntry::writeToFile(std::ofstream& rOFStream) const
{
if ( rOFStream.tellp() != std::ofstream::pos_type( 0 ))
rOFStream << std::endl;
if ( !m_sExtractCom.isEmpty() )
rOFStream
<< "#. "
<< m_sExtractCom.toString().replaceAll("\n"_ostr,"\n#. "_ostr) << std::endl;
for(const auto& rReference : m_sReferences)
rOFStream << "#: " << rReference << std::endl;
if ( m_bFuzzy )
rOFStream << "#, fuzzy" << std::endl;
if ( m_bCFormat )
rOFStream << "#, c-format" << std::endl;
if ( !m_sMsgCtxt.isEmpty() )
rOFStream << "msgctxt "
<< lcl_GenMsgString(m_sMsgCtxt)
<< std::endl;
rOFStream << "msgid "
<< lcl_GenMsgString(m_sMsgId) << std::endl;
if ( !m_sMsgIdPlural.isEmpty() )
rOFStream << "msgid_plural "
<< lcl_GenMsgString(m_sMsgIdPlural)
<< std::endl;
if ( !m_sMsgStrPlural.empty() )
for(auto & line : m_sMsgStrPlural)
rOFStream << line.copy(0,10) << lcl_GenMsgString(line.subView(10)) << std::endl;
else
rOFStream << "msgstr "
<< lcl_GenMsgString(m_sMsgStr) << std::endl;
}
void GenPoEntry::readFromFile(std::ifstream& rIFStream)
{
*this = GenPoEntry();
OString* pLastMsg = nullptr;
std::string sTemp;
getline(rIFStream,sTemp);
if( rIFStream.eof() || sTemp.empty() )
{
m_bNull = true;
return;
}
while(!rIFStream.eof())
{
OString sLine(sTemp.data(),sTemp.length());
if (sLine.startsWith("#. "))
{
if( !m_sExtractCom.isEmpty() )
{
m_sExtractCom.append("\n");
}
m_sExtractCom.append(sLine.subView(3));
}
else if (sLine.startsWith("#: "))
{
m_sReferences.push_back(sLine.copy(3));
}
else if (sLine.startsWith("#, fuzzy"))
{
m_bFuzzy = true;
}
else if (sLine.startsWith("#, c-format"))
{
m_bCFormat = true;
}
else if (sLine.startsWith("msgctxt "))
{
m_sMsgCtxt = lcl_GenNormString(sLine.subView(8));
pLastMsg = &m_sMsgCtxt;
}
else if (sLine.startsWith("msgid "))
{
m_sMsgId = lcl_GenNormString(sLine.subView(6));
pLastMsg = &m_sMsgId;
}
else if (sLine.startsWith("msgid_plural "))
{
m_sMsgIdPlural = lcl_GenNormString(sLine.subView(13));
pLastMsg = &m_sMsgIdPlural;
}
else if (sLine.startsWith("msgstr "))
{
m_sMsgStr = lcl_GenNormString(sLine.subView(7));
pLastMsg = &m_sMsgStr;
}
else if (sLine.startsWith("msgstr["))
{
// assume there are no more than 10 plural forms...
// and that plural strings are never split to multi-line in po
m_sMsgStrPlural.push_back(sLine.subView(0,10) + lcl_GenNormString(sLine.subView(10)));
}
else if (sLine.startsWith("\"") && pLastMsg)
{
OString sReference;
if (!m_sReferences.empty())
{
sReference = m_sReferences.front();
}
if (pLastMsg != &m_sMsgCtxt || sLine != Concat2View("\"" + sReference + "\\n\""))
{
*pLastMsg += lcl_GenNormString(sLine);
}
}
else
break;
getline(rIFStream,sTemp);
}
}
PoEntry::PoEntry()
: m_bIsInitialized( false )
{
}
PoEntry::PoEntry(
std::string_view rSourceFile, std::string_view rResType, std::string_view rGroupId,
std::string_view rLocalId, std::string_view rHelpText,
const OString& rText, const TYPE eType )
: m_bIsInitialized( false )
{
if( rSourceFile.empty() )
throw NOSOURCFILE;
else if ( rResType.empty() )
throw NORESTYPE;
else if ( rGroupId.empty() )
throw NOGROUPID;
else if ( rText.isEmpty() )
throw NOSTRING;
else if ( rHelpText.size() == 5 )
throw WRONGHELPTEXT;
m_pGenPo.reset( new GenPoEntry() );
size_t idx = rSourceFile.rfind('/');
if (idx == std::string_view::npos)
idx = 0;
OString sReference(rSourceFile.substr(idx+1));
m_pGenPo->setReference(sReference);
OString sMsgCtxt =
sReference + "\n" +
rGroupId + "\n" +
(rLocalId.empty() ? OString() : OString::Concat(rLocalId) + "\n") +
rResType;
switch(eType){
case TTEXT:
sMsgCtxt += ".text"; break;
case TQUICKHELPTEXT:
sMsgCtxt += ".quickhelptext"; break;
case TTITLE:
sMsgCtxt += ".title"; break;
// Default case is unneeded because the type of eType has only three element
}
m_pGenPo->setMsgCtxt(sMsgCtxt);
m_pGenPo->setMsgId(rText);
m_pGenPo->setExtractCom(Concat2View(
( !rHelpText.empty() ? OString::Concat(rHelpText) + "\n" : OString()) +
genKeyId( m_pGenPo->getReference().front() + rGroupId + rLocalId + rResType + rText ) ));
m_bIsInitialized = true;
}
PoEntry::~PoEntry()
{
}
PoEntry::PoEntry( const PoEntry& rPo )
: m_pGenPo( rPo.m_pGenPo ? new GenPoEntry( *(rPo.m_pGenPo) ) : nullptr )
, m_bIsInitialized( rPo.m_bIsInitialized )
{
}
PoEntry& PoEntry::operator=(const PoEntry& rPo)
{
if( this == &rPo )
{
return *this;
}
if( rPo.m_pGenPo )
{
if( m_pGenPo )
{
*m_pGenPo = *(rPo.m_pGenPo);
}
else
{
m_pGenPo.reset( new GenPoEntry( *(rPo.m_pGenPo) ) );
}
}
else
{
m_pGenPo.reset();
}
m_bIsInitialized = rPo.m_bIsInitialized;
return *this;
}
PoEntry& PoEntry::operator=(PoEntry&& rPo) noexcept
{
m_pGenPo = std::move(rPo.m_pGenPo);
m_bIsInitialized = std::move(rPo.m_bIsInitialized);
return *this;
}
OString const & PoEntry::getSourceFile() const
{
assert( m_bIsInitialized );
return m_pGenPo->getReference().front();
}
OString PoEntry::getGroupId() const
{
assert( m_bIsInitialized );
return m_pGenPo->getMsgCtxt().getToken(0,'\n');
}
OString PoEntry::getLocalId() const
{
assert( m_bIsInitialized );
const OString sMsgCtxt = m_pGenPo->getMsgCtxt();
if (sMsgCtxt.indexOf('\n')==sMsgCtxt.lastIndexOf('\n'))
return OString();
else
return sMsgCtxt.getToken(1,'\n');
}
OString PoEntry::getResourceType() const
{
assert( m_bIsInitialized );
const OString sMsgCtxt = m_pGenPo->getMsgCtxt();
if (sMsgCtxt.indexOf('\n')==sMsgCtxt.lastIndexOf('\n'))
return sMsgCtxt.getToken(1,'\n').getToken(0,'.');
else
return sMsgCtxt.getToken(2,'\n').getToken(0,'.');
}
PoEntry::TYPE PoEntry::getType() const
{
assert( m_bIsInitialized );
const OString sMsgCtxt = m_pGenPo->getMsgCtxt();
const OString sType = sMsgCtxt.copy( sMsgCtxt.lastIndexOf('.') + 1 );
assert(
(sType == "text" || sType == "quickhelptext" || sType == "title") );
if ( sType == "text" )
return TTEXT;
else if ( sType == "quickhelptext" )
return TQUICKHELPTEXT;
else
return TTITLE;
}
bool PoEntry::isFuzzy() const
{
assert( m_bIsInitialized );
return m_pGenPo->isFuzzy();
}
// Get message context
const OString& PoEntry::getMsgCtxt() const
{
assert( m_bIsInitialized );
return m_pGenPo->getMsgCtxt();
}
// Get translation string in merge format
OString const & PoEntry::getMsgId() const
{
assert( m_bIsInitialized );
return m_pGenPo->getMsgId();
}
// Get translated string in merge format
const OString& PoEntry::getMsgStr() const
{
assert( m_bIsInitialized );
return m_pGenPo->getMsgStr();
}
bool PoEntry::IsInSameComp(const PoEntry& rPo1,const PoEntry& rPo2)
{
assert( rPo1.m_bIsInitialized && rPo2.m_bIsInitialized );
return ( rPo1.getSourceFile() == rPo2.getSourceFile() &&
rPo1.getGroupId() == rPo2.getGroupId() &&
rPo1.getLocalId() == rPo2.getLocalId() &&
rPo1.getResourceType() == rPo2.getResourceType() );
}
OString PoEntry::genKeyId(const OString& rGenerator)
{
sal_uInt32 nCRC = rtl_crc32(0, rGenerator.getStr(), rGenerator.getLength());
// Use simple ASCII characters, exclude I, l, 1 and O, 0 to avoid confusing IDs
static const char sSymbols[] =
"ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz23456789";
char sKeyId[6];
for( short nKeyInd = 0; nKeyInd < 5; ++nKeyInd )
{
sKeyId[nKeyInd] = sSymbols[(nCRC & 63) % strlen(sSymbols)];
nCRC >>= 6;
}
sKeyId[5] = '\0';
return sKeyId;
}
namespace
{
// Get actual time in "YEAR-MO-DA HO:MI+ZONE" form
OString lcl_GetTime()
{
time_t aNow = time(nullptr);
struct tm* pNow = localtime(&aNow);
char pBuff[50];
strftime( pBuff, sizeof pBuff, "%Y-%m-%d %H:%M%z", pNow );
return pBuff;
}
}
// when updating existing files (pocheck), reuse provided po-header
PoHeader::PoHeader( std::string_view rExtSrc, const OString& rPoHeaderMsgStr )
: m_pGenPo( new GenPoEntry() )
, m_bIsInitialized( false )
{
m_pGenPo->setExtractCom(Concat2View(OString::Concat("extracted from ") + rExtSrc));
m_pGenPo->setMsgStr(rPoHeaderMsgStr);
m_bIsInitialized = true;
}
PoHeader::PoHeader( std::string_view rExtSrc )
: m_pGenPo( new GenPoEntry() )
, m_bIsInitialized( false )
{
m_pGenPo->setExtractCom(Concat2View(OString::Concat("extracted from ") + rExtSrc));
m_pGenPo->setMsgStr(
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?"
"product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n"
"POT-Creation-Date: " + lcl_GetTime() +
"\nPO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"X-Accelerator-Marker: ~\n"
"X-Generator: LibreOffice\n");
m_bIsInitialized = true;
}
PoHeader::~PoHeader()
{
}
PoOfstream::PoOfstream()
: m_bIsAfterHeader( false )
{
}
PoOfstream::PoOfstream(const OString& rFileName, OpenMode aMode )
: m_bIsAfterHeader( false )
{
open( rFileName, aMode );
}
PoOfstream::~PoOfstream()
{
if( isOpen() )
{
close();
}
}
void PoOfstream::open(const OString& rFileName, OpenMode aMode )
{
assert( !isOpen() );
if( aMode == TRUNC )
{
m_aOutPut.open( rFileName.getStr(),
std::ios_base::out | std::ios_base::trunc );
m_bIsAfterHeader = false;
}
else if( aMode == APP )
{
m_aOutPut.open( rFileName.getStr(),
std::ios_base::out | std::ios_base::app );
m_bIsAfterHeader = m_aOutPut.tellp() != std::ofstream::pos_type( 0 );
}
}
void PoOfstream::close()
{
assert( isOpen() );
m_aOutPut.close();
}
void PoOfstream::writeHeader(const PoHeader& rPoHeader)
{
assert( isOpen() && !m_bIsAfterHeader && rPoHeader.m_bIsInitialized );
rPoHeader.m_pGenPo->writeToFile( m_aOutPut );
m_bIsAfterHeader = true;
}
void PoOfstream::writeEntry( const PoEntry& rPoEntry )
{
assert( isOpen() && m_bIsAfterHeader && rPoEntry.m_bIsInitialized );
rPoEntry.m_pGenPo->writeToFile( m_aOutPut );
}
namespace
{
// Check the validity of read entry
bool lcl_CheckInputEntry(const GenPoEntry& rEntry)
{
// stock button labels don't have a reference/sourcefile - they are not extracted from ui files
// (explicitly skipped by solenv/bin/uiex) but instead inserted by l10ntools/source/localize.cxx
// into all module templates (see d5d905b480c2a9b1db982f2867e87b5c230d1ab9)
return !rEntry.getMsgCtxt().isEmpty() &&
(rEntry.getMsgCtxt() == "stock" || !rEntry.getReference().empty()) &&
!rEntry.getMsgId().isEmpty();
}
}
PoIfstream::PoIfstream()
: m_bEof( false )
{
}
PoIfstream::PoIfstream(const OString& rFileName)
: m_bEof( false )
{
open( rFileName );
}
PoIfstream::~PoIfstream()
{
if( isOpen() )
{
close();
}
}
void PoIfstream::open( const OString& rFileName, OString& rPoHeader )
{
assert( !isOpen() );
m_aInPut.open( rFileName.getStr(), std::ios_base::in );
// capture header, updating timestamp and generator
std::string sTemp;
std::getline(m_aInPut,sTemp);
while( !sTemp.empty() && !m_aInPut.eof() )
{
std::getline(m_aInPut,sTemp);
OString sLine(sTemp.data(),sTemp.length());
if (sLine.startsWith("\"PO-Revision-Date"))
rPoHeader += "PO-Revision-Date: " + lcl_GetTime() + "\n";
else if (sLine.startsWith("\"X-Generator"))
rPoHeader += "X-Generator: LibreOffice\n";
else if (sLine.startsWith("\""))
rPoHeader += lcl_GenNormString(sLine);
}
m_bEof = false;
}
void PoIfstream::open( const OString& rFileName )
{
assert( !isOpen() );
m_aInPut.open( rFileName.getStr(), std::ios_base::in );
// Skip header
std::string sTemp;
std::getline(m_aInPut,sTemp);
while( !sTemp.empty() && !m_aInPut.eof() )
{
std::getline(m_aInPut,sTemp);
}
m_bEof = false;
}
void PoIfstream::close()
{
assert( isOpen() );
m_aInPut.close();
}
void PoIfstream::readEntry( PoEntry& rPoEntry )
{
assert( isOpen() && !eof() );
GenPoEntry aGenPo;
aGenPo.readFromFile( m_aInPut );
if( aGenPo.isNull() )
{
m_bEof = true;
rPoEntry = PoEntry();
}
else
{
if( lcl_CheckInputEntry(aGenPo) )
{
if( rPoEntry.m_pGenPo )
{
*(rPoEntry.m_pGenPo) = aGenPo;
}
else
{
rPoEntry.m_pGenPo.reset( new GenPoEntry( aGenPo ) );
}
rPoEntry.m_bIsInitialized = true;
}
else
{
SAL_WARN("l10ntools", "Parse problem with entry: " << aGenPo.getMsgStr());
throw PoIfstream::Exception();
}
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|