зеркало из https://github.com/mozilla/gecko-dev.git
Add a lightweight reader for Mork files. Bug 322369, r=brettw.
This commit is contained in:
bryner%brianryner.com
Родитель
6b682d8476
Коммит
f5bf52d888
|
|
@ -88,6 +88,7 @@ db/mork/src/Makefile
|
|||
|
||||
MAKEFILES_storage="
|
||||
db/sqlite3/src/Makefile
|
||||
db/morkreader/Makefile
|
||||
storage/Makefile
|
||||
storage/public/Makefile
|
||||
storage/src/Makefile
|
||||
|
|
|
|||
|
|
@ -120,6 +120,7 @@ MODULES_core := \
|
|||
mozilla/toolkit \
|
||||
mozilla/storage \
|
||||
mozilla/db/sqlite3 \
|
||||
mozilla/db/morkreader \
|
||||
mozilla/tools/cross-commit \
|
||||
$(NULL)
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
Makefile
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
#
|
||||
# ***** BEGIN LICENSE BLOCK *****
|
||||
# Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
||||
#
|
||||
# The contents of this file are subject to the Mozilla Public License Version
|
||||
# 1.1 (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.mozilla.org/MPL/
|
||||
#
|
||||
# Software distributed under the License is distributed on an "AS IS" basis,
|
||||
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
||||
# for the specific language governing rights and limitations under the
|
||||
# License.
|
||||
#
|
||||
# The Original Code is Places code
|
||||
#
|
||||
# The Initial Developer of the Original Code is
|
||||
# Google Inc.
|
||||
# Portions created by the Initial Developer are Copyright (C) 2006
|
||||
# the Initial Developer. All Rights Reserved.
|
||||
#
|
||||
# Contributor(s):
|
||||
# Brian Ryner <bryner@brianryner.com>
|
||||
#
|
||||
# Alternatively, the contents of this file may be used under the terms of
|
||||
# either the GNU General Public License Version 2 or later (the "GPL"), or
|
||||
# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
||||
# in which case the provisions of the GPL or the LGPL are applicable instead
|
||||
# of those above. If you wish to allow use of your version of this file only
|
||||
# under the terms of either the GPL or the LGPL, and not to allow others to
|
||||
# use your version of this file under the terms of the MPL, indicate your
|
||||
# decision by deleting the provisions above and replace them with the notice
|
||||
# and other provisions required by the GPL or the LGPL. If you do not delete
|
||||
# the provisions above, a recipient may use your version of this file under
|
||||
# the terms of any one of the MPL, the GPL or the LGPL.
|
||||
#
|
||||
# ***** END LICENSE BLOCK *****
|
||||
|
||||
DEPTH = ../..
|
||||
topsrcdir = @top_srcdir@
|
||||
srcdir = @srcdir@
|
||||
VPATH = @srcdir@
|
||||
|
||||
include $(DEPTH)/config/autoconf.mk
|
||||
|
||||
MODULE = morkreader
|
||||
LIBRARY_NAME = morkreader_s
|
||||
MOZILLA_INTERNAL_API = 1
|
||||
FORCE_STATIC_LIB = 1
|
||||
|
||||
REQUIRES = xpcom \
|
||||
string \
|
||||
necko \
|
||||
$(NULL)
|
||||
|
||||
EXPORTS = nsMorkReader.h
|
||||
CPPSRCS = nsMorkReader.cpp
|
||||
|
||||
include $(topsrcdir)/config/rules.mk
|
||||
|
||||
|
|
@ -0,0 +1,461 @@
|
|||
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
||||
/* ***** BEGIN LICENSE BLOCK *****
|
||||
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
||||
*
|
||||
* The contents of this file are subject to the Mozilla Public License Version
|
||||
* 1.1 (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.mozilla.org/MPL/
|
||||
*
|
||||
* Software distributed under the License is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
||||
* for the specific language governing rights and limitations under the
|
||||
* License.
|
||||
*
|
||||
* The Original Code is Places.
|
||||
*
|
||||
* The Initial Developer of the Original Code is
|
||||
* Google Inc.
|
||||
* Portions created by the Initial Developer are Copyright (C) 2006
|
||||
* the Initial Developer. All Rights Reserved.
|
||||
*
|
||||
* Contributor(s):
|
||||
* Brian Ryner <bryner@brianryner.com> (original author)
|
||||
*
|
||||
* Alternatively, the contents of this file may be used under the terms of
|
||||
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
||||
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
||||
* in which case the provisions of the GPL or the LGPL are applicable instead
|
||||
* of those above. If you wish to allow use of your version of this file only
|
||||
* under the terms of either the GPL or the LGPL, and not to allow others to
|
||||
* use your version of this file under the terms of the MPL, indicate your
|
||||
* decision by deleting the provisions above and replace them with the notice
|
||||
* and other provisions required by the GPL or the LGPL. If you do not delete
|
||||
* the provisions above, a recipient may use your version of this file under
|
||||
* the terms of any one of the MPL, the GPL or the LGPL.
|
||||
*
|
||||
* ***** END LICENSE BLOCK ***** */
|
||||
|
||||
#include "nsMorkReader.h"
|
||||
#include "prio.h"
|
||||
#include "nsNetUtil.h"
|
||||
|
||||
// A FixedString implementation that can hold an 80-character line
|
||||
class nsCLineString : public nsFixedCString
|
||||
{
|
||||
public:
|
||||
nsCLineString() : fixed_string_type(mStorage, sizeof(mStorage), 0) {}
|
||||
explicit nsCLineString(const substring_type& str)
|
||||
: fixed_string_type(mStorage, sizeof(mStorage), 0)
|
||||
{
|
||||
Assign(str);
|
||||
}
|
||||
|
||||
private:
|
||||
char mStorage[80];
|
||||
};
|
||||
|
||||
// Convert a hex character (0-9, A-F) to its corresponding byte value.
|
||||
// The character pointed to by 'c' is modified in place.
|
||||
inline PRBool
|
||||
ConvertChar(char *c)
|
||||
{
|
||||
char c1 = *c;
|
||||
if ('0' <= c1 && c1 <= '9') {
|
||||
*c = c1 - '0';
|
||||
return PR_TRUE;
|
||||
} else if ('A' <= c1 && c1 <= 'F') {
|
||||
*c = c1 - 'A' + 10;
|
||||
return PR_TRUE;
|
||||
}
|
||||
return PR_FALSE;
|
||||
}
|
||||
|
||||
// Unescape a Mork value. Mork uses $xx escaping to encode non-ASCII
|
||||
// characters. Additionally, '$' and '\' are backslash-escaped.
|
||||
// The result of the unescape is in returned into aResult.
|
||||
|
||||
static void
|
||||
MorkUnescape(const nsCSubstring &aString, nsCString &aResult)
|
||||
{
|
||||
PRUint32 len = aString.Length();
|
||||
PRInt32 startIndex = -1;
|
||||
for (PRUint32 i = 0; i < len; ++i) {
|
||||
char c = aString[i];
|
||||
if (c == '\\') {
|
||||
if (startIndex != -1) {
|
||||
aResult.Append(Substring(aString, startIndex, i - startIndex));
|
||||
startIndex = -1;
|
||||
}
|
||||
if (i < len - 1) {
|
||||
aResult.Append(aString[++i]);
|
||||
}
|
||||
} else if (c == '$') {
|
||||
if (startIndex != -1) {
|
||||
aResult.Append(Substring(aString, startIndex, i - startIndex));
|
||||
startIndex = -1;
|
||||
}
|
||||
if (i < len - 2) {
|
||||
// Would be nice to use ToInteger() here, but it currently
|
||||
// requires a null-terminated string.
|
||||
char c2 = aString[++i];
|
||||
char c3 = aString[++i];
|
||||
if (ConvertChar(&c2) && ConvertChar(&c3)) {
|
||||
aResult.Append((c2 << 4 ) | c3);
|
||||
}
|
||||
}
|
||||
} else if (startIndex == -1) {
|
||||
startIndex = PRInt32(i);
|
||||
}
|
||||
}
|
||||
if (startIndex != -1) {
|
||||
aResult.Append(Substring(aString, startIndex, len - startIndex));
|
||||
}
|
||||
}
|
||||
|
||||
nsresult
|
||||
nsMorkReader::Init()
|
||||
{
|
||||
NS_ENSURE_TRUE(mColumnMap.Init(), NS_ERROR_OUT_OF_MEMORY);
|
||||
NS_ENSURE_TRUE(mValueMap.Init(), NS_ERROR_OUT_OF_MEMORY);
|
||||
NS_ENSURE_TRUE(mMetaRow.Init(), NS_ERROR_OUT_OF_MEMORY);
|
||||
NS_ENSURE_TRUE(mTable.Init(), NS_ERROR_OUT_OF_MEMORY);
|
||||
return NS_OK;
|
||||
}
|
||||
|
||||
PR_STATIC_CALLBACK(PLDHashOperator)
|
||||
DeleteStringMap(const nsACString& aKey,
|
||||
nsMorkReader::StringMap *aData,
|
||||
void *aUserArg)
|
||||
{
|
||||
delete aData;
|
||||
return PL_DHASH_NEXT;
|
||||
}
|
||||
|
||||
nsMorkReader::~nsMorkReader()
|
||||
{
|
||||
mTable.EnumerateRead(DeleteStringMap, nsnull);
|
||||
}
|
||||
|
||||
nsresult
|
||||
nsMorkReader::Read(nsIFile *aFile)
|
||||
{
|
||||
nsCOMPtr<nsIFileInputStream> stream =
|
||||
do_CreateInstance(NS_LOCALFILEINPUTSTREAM_CONTRACTID);
|
||||
NS_ENSURE_TRUE(stream, NS_ERROR_FAILURE);
|
||||
|
||||
nsresult rv = stream->Init(aFile, PR_RDONLY, 0, 0);
|
||||
NS_ENSURE_SUCCESS(rv, rv);
|
||||
|
||||
mStream = do_QueryInterface(stream);
|
||||
NS_ASSERTION(mStream, "file input stream must impl nsILineInputStream");
|
||||
|
||||
nsCLineString line;
|
||||
rv = ReadLine(line);
|
||||
if (!line.EqualsLiteral("// <!-- <mdb:mork:z v=\"1.4\"/> -->")) {
|
||||
return NS_ERROR_FAILURE; // unexpected file format
|
||||
}
|
||||
|
||||
while (NS_SUCCEEDED(ReadLine(line))) {
|
||||
// Trim off leading spaces
|
||||
PRUint32 idx = 0, len = line.Length();
|
||||
while (idx < len && line[idx] == ' ') {
|
||||
++idx;
|
||||
}
|
||||
if (idx >= len) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const nsCSubstring &l = Substring(line, idx);
|
||||
|
||||
// Look at the line to figure out what section type this is
|
||||
if (StringBeginsWith(l, NS_LITERAL_CSTRING("< <(a=c)>"))) {
|
||||
// Column map
|
||||
rv = ParseMap(l, &mColumnMap);
|
||||
NS_ENSURE_SUCCESS(rv, rv);
|
||||
} else if (StringBeginsWith(l, NS_LITERAL_CSTRING("<("))) {
|
||||
// Value map
|
||||
rv = ParseMap(l, &mValueMap);
|
||||
NS_ENSURE_SUCCESS(rv, rv);
|
||||
} else if (l[0] == '{' || l[0] == '[') {
|
||||
// Table / table row
|
||||
rv = ParseTable(l);
|
||||
NS_ENSURE_SUCCESS(rv, rv);
|
||||
} else {
|
||||
// Don't know, hopefully don't care
|
||||
}
|
||||
}
|
||||
|
||||
return NS_OK;
|
||||
}
|
||||
|
||||
void
|
||||
nsMorkReader::EnumerateColumns(ColumnEnumerator aCallback,
|
||||
void *aUserData) const
|
||||
{
|
||||
mColumnMap.EnumerateRead(aCallback, aUserData);
|
||||
}
|
||||
|
||||
void
|
||||
nsMorkReader::EnumerateRows(RowEnumerator aCallback, void *aUserData) const
|
||||
{
|
||||
// Constify the table values
|
||||
typedef const nsDataHashtable<nsCStringHashKey, const StringMap*> ConstTable;
|
||||
NS_REINTERPRET_CAST(ConstTable*, &mTable)->EnumerateRead(aCallback,
|
||||
aUserData);
|
||||
}
|
||||
|
||||
// Parses a key/value map of the form
|
||||
// <(k1=v1)(k2=v2)...>
|
||||
|
||||
nsresult
|
||||
nsMorkReader::ParseMap(const nsCSubstring &aLine, StringMap *aMap)
|
||||
{
|
||||
nsCLineString line(aLine);
|
||||
nsCAutoString key;
|
||||
nsresult rv = NS_OK;
|
||||
|
||||
// If the first line is the a=c line (column map), just skip over it.
|
||||
if (StringBeginsWith(line, NS_LITERAL_CSTRING("< <(a=c)>"))) {
|
||||
rv = ReadLine(line);
|
||||
}
|
||||
|
||||
for (; NS_SUCCEEDED(rv); rv = ReadLine(line)) {
|
||||
PRUint32 idx = 0;
|
||||
PRUint32 len = line.Length();
|
||||
PRUint32 tokenStart;
|
||||
|
||||
while (idx < len) {
|
||||
switch (line[idx++]) {
|
||||
case '(':
|
||||
// Beginning of a key/value pair
|
||||
if (!key.IsEmpty()) {
|
||||
NS_WARNING("unterminated key/value pair?");
|
||||
key.Truncate(0);
|
||||
}
|
||||
|
||||
tokenStart = idx;
|
||||
while (idx < len && line[idx] != '=') {
|
||||
++idx;
|
||||
}
|
||||
key = Substring(line, tokenStart, idx - tokenStart);
|
||||
break;
|
||||
case '=':
|
||||
{
|
||||
// Beginning of the value
|
||||
if (key.IsEmpty()) {
|
||||
NS_WARNING("stray value");
|
||||
break;
|
||||
}
|
||||
|
||||
tokenStart = idx;
|
||||
while (idx < len && line[idx] != ')') {
|
||||
if (line[idx] == '\\') {
|
||||
++idx; // skip escaped ')' characters
|
||||
}
|
||||
++idx;
|
||||
}
|
||||
PRUint32 tokenEnd = PR_MIN(idx, len);
|
||||
++idx;
|
||||
|
||||
nsCAutoString value;
|
||||
MorkUnescape(Substring(line, tokenStart, tokenEnd - tokenStart),
|
||||
value);
|
||||
aMap->Put(key, value);
|
||||
key.Truncate(0);
|
||||
break;
|
||||
}
|
||||
case '>':
|
||||
// End of the map.
|
||||
NS_WARN_IF_FALSE(key.IsEmpty(),
|
||||
"map terminates inside of key/value pair");
|
||||
return NS_OK;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// We ran out of lines and the map never terminated. This probably indicates
|
||||
// a parsing error.
|
||||
NS_WARNING("didn't find end of key/value map");
|
||||
return NS_ERROR_FAILURE;
|
||||
}
|
||||
|
||||
// Parses a table row of the form [123(^45^67)..]
|
||||
// (row id 123 has the value with id 67 for the column with id 45).
|
||||
// A '^' prefix for a column or value references an entry in the column or
|
||||
// value map. '=' is used as the separator when the value is a literal.
|
||||
|
||||
nsresult
|
||||
nsMorkReader::ParseTable(const nsCSubstring &aLine)
|
||||
{
|
||||
nsCLineString line(aLine);
|
||||
nsCAutoString column;
|
||||
StringMap *currentRow = nsnull;
|
||||
PRBool inMetaRow = PR_FALSE;
|
||||
|
||||
do {
|
||||
PRUint32 idx = 0;
|
||||
PRUint32 len = line.Length();
|
||||
PRUint32 tokenStart, tokenEnd;
|
||||
|
||||
while (idx < len) {
|
||||
switch (line[idx++]) {
|
||||
case '{':
|
||||
// This marks the beginning of a table section. There's a lot of
|
||||
// junk before the first row that looks like cell values but isn't.
|
||||
// Skip to the first '['.
|
||||
while (idx < len && line[idx] != '[') {
|
||||
if (line[idx] == '{') {
|
||||
inMetaRow = PR_TRUE; // the meta row is enclosed in { }
|
||||
} else if (line[idx] == '}') {
|
||||
inMetaRow = PR_FALSE;
|
||||
}
|
||||
++idx;
|
||||
}
|
||||
break;
|
||||
case '[':
|
||||
{
|
||||
// Start of a new row. Consume the row id, up to the first '('.
|
||||
if (currentRow) {
|
||||
NS_WARNING("unterminated row?");
|
||||
currentRow = nsnull;
|
||||
}
|
||||
|
||||
// Check for a '-' at the start of the id. This signifies that
|
||||
// if the row already exists, we should delete all columns from it
|
||||
// before adding the new values.
|
||||
PRBool cutColumns;
|
||||
if (idx < len && line[idx] == '-') {
|
||||
cutColumns = PR_TRUE;
|
||||
++idx;
|
||||
} else {
|
||||
cutColumns = PR_FALSE;
|
||||
}
|
||||
|
||||
tokenStart = idx;
|
||||
while (idx < len && line[idx] != '(' && line[idx] != ']') {
|
||||
++idx;
|
||||
}
|
||||
|
||||
if (inMetaRow) {
|
||||
currentRow = &mMetaRow;
|
||||
} else {
|
||||
const nsCSubstring& row = Substring(line,
|
||||
tokenStart, idx - tokenStart);
|
||||
if (!mTable.Get(row, ¤tRow)) {
|
||||
currentRow = new StringMap();
|
||||
NS_ENSURE_TRUE(currentRow && currentRow->Init(),
|
||||
NS_ERROR_OUT_OF_MEMORY);
|
||||
mTable.Put(row, currentRow);
|
||||
}
|
||||
}
|
||||
if (cutColumns) {
|
||||
currentRow->Clear();
|
||||
}
|
||||
break;
|
||||
}
|
||||
case ']':
|
||||
// We're done with the row
|
||||
currentRow = nsnull;
|
||||
inMetaRow = PR_FALSE;
|
||||
break;
|
||||
case '(':
|
||||
if (!currentRow) {
|
||||
NS_WARNING("cell value outside of row");
|
||||
break;
|
||||
}
|
||||
|
||||
if (!column.IsEmpty()) {
|
||||
NS_WARNING("unterminated cell?");
|
||||
column.Truncate(0);
|
||||
}
|
||||
|
||||
if (line[idx] == '^') {
|
||||
++idx; // this is not part of the column id, advance past it
|
||||
}
|
||||
tokenStart = idx;
|
||||
while (idx < len && line[idx] != '^' && line[idx] != '=') {
|
||||
if (line[idx] == '\\') {
|
||||
++idx; // skip escaped characters
|
||||
}
|
||||
++idx;
|
||||
}
|
||||
|
||||
tokenEnd = PR_MIN(idx, len);
|
||||
MorkUnescape(Substring(line, tokenStart, tokenEnd - tokenStart),
|
||||
column);
|
||||
break;
|
||||
case '=':
|
||||
case '^':
|
||||
if (column.IsEmpty()) {
|
||||
NS_WARNING("stray ^ or = marker");
|
||||
break;
|
||||
}
|
||||
|
||||
tokenStart = idx - 1; // include the '=' or '^' marker in the value
|
||||
while (idx < len && line[idx] != ')') {
|
||||
if (line[idx] == '\\') {
|
||||
++idx; // skip escaped characters
|
||||
}
|
||||
++idx;
|
||||
}
|
||||
tokenEnd = PR_MIN(idx, len);
|
||||
++idx;
|
||||
|
||||
nsCAutoString value;
|
||||
MorkUnescape(Substring(line, tokenStart, tokenEnd - tokenStart),
|
||||
value);
|
||||
currentRow->Put(column, value);
|
||||
column.Truncate(0);
|
||||
break;
|
||||
}
|
||||
}
|
||||
} while (currentRow && NS_SUCCEEDED(ReadLine(line)));
|
||||
|
||||
return NS_OK;
|
||||
}
|
||||
|
||||
nsresult
|
||||
nsMorkReader::ReadLine(nsCString &aLine)
|
||||
{
|
||||
PRBool res;
|
||||
nsresult rv = mStream->ReadLine(aLine, &res);
|
||||
NS_ENSURE_SUCCESS(rv, rv);
|
||||
if (!res) {
|
||||
return NS_ERROR_NOT_AVAILABLE;
|
||||
}
|
||||
|
||||
while (!aLine.IsEmpty() && aLine.Last() == '\\') {
|
||||
// There is a continuation for this line. Read it and append.
|
||||
nsCLineString line2;
|
||||
rv = mStream->ReadLine(line2, &res);
|
||||
NS_ENSURE_SUCCESS(rv, rv);
|
||||
if (!res) {
|
||||
return NS_ERROR_NOT_AVAILABLE;
|
||||
}
|
||||
aLine.Truncate(aLine.Length() - 1);
|
||||
aLine.Append(line2);
|
||||
}
|
||||
|
||||
return NS_OK;
|
||||
}
|
||||
|
||||
void
|
||||
nsMorkReader::NormalizeValue(nsCString &aValue) const
|
||||
{
|
||||
PRUint32 len = aValue.Length();
|
||||
if (len == 0) {
|
||||
return;
|
||||
}
|
||||
const nsCSubstring &str = Substring(aValue, 1, len - 1);
|
||||
char c = aValue[0];
|
||||
if (c == '^') {
|
||||
if (!mValueMap.Get(str, &aValue)) {
|
||||
aValue.Truncate(0);
|
||||
}
|
||||
} else if (c == '=') {
|
||||
aValue.Assign(str);
|
||||
} else {
|
||||
aValue.Truncate(0);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,134 @@
|
|||
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
||||
/* ***** BEGIN LICENSE BLOCK *****
|
||||
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
||||
*
|
||||
* The contents of this file are subject to the Mozilla Public License Version
|
||||
* 1.1 (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.mozilla.org/MPL/
|
||||
*
|
||||
* Software distributed under the License is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
||||
* for the specific language governing rights and limitations under the
|
||||
* License.
|
||||
*
|
||||
* The Original Code is Places.
|
||||
*
|
||||
* The Initial Developer of the Original Code is
|
||||
* Google Inc.
|
||||
* Portions created by the Initial Developer are Copyright (C) 2006
|
||||
* the Initial Developer. All Rights Reserved.
|
||||
*
|
||||
* Contributor(s):
|
||||
* Brian Ryner <bryner@brianryner.com> (original author)
|
||||
*
|
||||
* Alternatively, the contents of this file may be used under the terms of
|
||||
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
||||
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
||||
* in which case the provisions of the GPL or the LGPL are applicable instead
|
||||
* of those above. If you wish to allow use of your version of this file only
|
||||
* under the terms of either the GPL or the LGPL, and not to allow others to
|
||||
* use your version of this file under the terms of the MPL, indicate your
|
||||
* decision by deleting the provisions above and replace them with the notice
|
||||
* and other provisions required by the GPL or the LGPL. If you do not delete
|
||||
* the provisions above, a recipient may use your version of this file under
|
||||
* the terms of any one of the MPL, the GPL or the LGPL.
|
||||
*
|
||||
* ***** END LICENSE BLOCK ***** */
|
||||
|
||||
#ifndef nsMorkReader_h_
|
||||
#define nsMorkReader_h_
|
||||
|
||||
#include "nsDataHashtable.h"
|
||||
#include "nsILineInputStream.h"
|
||||
|
||||
// The nsMorkReader object allows a consumer to read in a mork-format
|
||||
// file and enumerate the rows that it contains. It does not provide
|
||||
// any functionality for modifying mork tables.
|
||||
|
||||
// References:
|
||||
// http://www.mozilla.org/mailnews/arch/mork/primer.txt
|
||||
// http://www.mozilla.org/mailnews/arch/mork/grammar.txt
|
||||
// http://www.jwz.org/hacks/mork.pl
|
||||
|
||||
class nsMorkReader
|
||||
{
|
||||
public:
|
||||
typedef nsDataHashtable<nsCStringHashKey,nsCString> StringMap;
|
||||
|
||||
// Enumerator callback type for processing column ids.
|
||||
// A column id is a short way to reference a particular column in the table.
|
||||
// These column ids can be used to look up cell values when enumerating rows.
|
||||
// columnID is the table-unique column id
|
||||
// name is the name of the column
|
||||
// userData is the opaque pointer passed to EnumerateColumns()
|
||||
// The callback can return PL_DHASH_NEXT to continue enumerating,
|
||||
// or PL_DHASH_STOP to stop.
|
||||
typedef PLDHashOperator
|
||||
(*PR_CALLBACK ColumnEnumerator)(const nsACString &columnID,
|
||||
nsCString name,
|
||||
void *userData);
|
||||
|
||||
// Enumerator callback type for processing table rows.
|
||||
// A row contains cells. Each cell specifies a column id, and the value
|
||||
// for the column for that row.
|
||||
// rowID is the table-unique row id
|
||||
// values contains the cell values, keyed by column id.
|
||||
// You should call NormalizeValue() on any cell value that you plan to use.
|
||||
// userData is the opaque pointer passed to EnumerateRows()
|
||||
// The callback can return PL_DHASH_NEXT to continue enumerating,
|
||||
// or PL_DHASH_STOP to stop.
|
||||
typedef PLDHashOperator
|
||||
(*PR_CALLBACK RowEnumerator)(const nsACString &rowID,
|
||||
const StringMap *values,
|
||||
void *userData);
|
||||
|
||||
// Initialize the importer object's data structures
|
||||
nsresult Init();
|
||||
|
||||
// Read in the given mork file
|
||||
// Note: currently, only single-table mork files are supported
|
||||
nsresult Read(nsIFile *aFile);
|
||||
|
||||
// Enumerate the columns in the current table.
|
||||
void EnumerateColumns(ColumnEnumerator aCallback, void *aUserData) const;
|
||||
|
||||
// Enumerate the rows in the current table.
|
||||
void EnumerateRows(RowEnumerator aCallback, void *aUserData) const;
|
||||
|
||||
// Get the "meta row" for the table. Each table has at most one meta row,
|
||||
// which records information about the table. Like normal rows, the
|
||||
// meta row is a collection of column id / value pairs.
|
||||
const StringMap& GetMetaRow() const { return mMetaRow; }
|
||||
|
||||
// Normalizes the cell value (resolves references to the value map).
|
||||
// aValue is modified in-place.
|
||||
void NormalizeValue(nsCString &aValue) const;
|
||||
|
||||
nsMorkReader() {}
|
||||
~nsMorkReader();
|
||||
|
||||
private:
|
||||
// Parses a line of the file which contains key/value pairs (either
|
||||
// the column map or the value map). Additional lines are read from
|
||||
// mStream if the line ends mid-entry. The pairs are added to aMap.
|
||||
nsresult ParseMap(const nsCSubstring &aLine, StringMap *aMap);
|
||||
|
||||
// Parses a line of the file which contains a table or row definition.
|
||||
// Additional lines are read from mStream of the line ends mid-row.
|
||||
// An entry is added to mTable using the row ID as the key, which contains
|
||||
// a column id -> value map for the row.
|
||||
nsresult ParseTable(const nsCSubstring &aLine);
|
||||
|
||||
// Reads a single logical line from mStream into aLine.
|
||||
// Any continuation lines are consumed and appended to the line.
|
||||
nsresult ReadLine(nsCString &aLine);
|
||||
|
||||
StringMap mColumnMap;
|
||||
StringMap mValueMap;
|
||||
StringMap mMetaRow;
|
||||
nsDataHashtable<nsCStringHashKey,StringMap*> mTable;
|
||||
nsCOMPtr<nsILineInputStream> mStream;
|
||||
};
|
||||
|
||||
#endif // nsMorkReader_h_
|
||||
Загрузка…
Ссылка в новой задаче