diff options
Diffstat (limited to 'portato')
| -rw-r--r-- | portato/__init__.py | 50 | ||||
| -rw-r--r-- | portato/backend/system_interface.py | 4 | ||||
| -rw-r--r-- | portato/db/__init__.py | 23 | ||||
| -rw-r--r-- | portato/db/eix_sql.py | 65 | ||||
| -rw-r--r-- | portato/db/hash.py (renamed from portato/db/dict.py) | 4 | ||||
| -rw-r--r-- | portato/db/sql.py | 3 | ||||
| -rw-r--r-- | portato/eix/__init__.py | 88 | ||||
| -rw-r--r-- | portato/eix/eix-format.html | 855 | ||||
| -rw-r--r-- | portato/eix/exceptions.py | 45 | ||||
| -rw-r--r-- | portato/eix/parser.pyx | 316 | ||||
| -rw-r--r-- | portato/eix/py_parser.py | 416 | ||||
| -rw-r--r-- | portato/ipc.pxd | 52 | ||||
| -rw-r--r-- | portato/ipc.pyx | 173 | ||||
| -rw-r--r-- | portato/listener.py | 64 | ||||
| -rw-r--r-- | portato/plugin.py | 35 | ||||
| -rw-r--r-- | portato/waiting_queue.py | 7 |
16 files changed, 2115 insertions, 85 deletions
diff --git a/portato/__init__.py b/portato/__init__.py index 653329c..44a4da4 100644 --- a/portato/__init__.py +++ b/portato/__init__.py @@ -14,13 +14,10 @@ from __future__ import absolute_import import gettext, locale import sys, os -import subprocess, threading -import atexit from optparse import OptionParser, SUPPRESS_HELP -from . import log +from .log import start as logstart from .constants import LOCALE_DIR, APP, VERSION -from .su import detect_su_command from .helper import debug, info, error # listener-handling @@ -46,7 +43,7 @@ def get_parser (use_ = False): parser = OptionParser(version = vers, prog = "portato", description = desc, usage = usage) - parser.add_option("--shm", action = "store", nargs = 3, type="long", dest = "shm", + parser.add_option("--mq", action = "store", nargs = 1, type="long", dest = "mq", default = None, help = SUPPRESS_HELP) parser.add_option("-F", "--no-fork", action = "store_true", dest = "nofork", default = False, @@ -54,31 +51,34 @@ def get_parser (use_ = False): return parser -def start(): - +def _sub_start (): # set gettext stuff locale.setlocale(locale.LC_ALL, '') gettext.install(APP, LOCALE_DIR, unicode = True) +def start(): + + # set gettext stuff + _sub_start() + # start logging - log.start(file=False) + logstart(file=False) # run parser (options, args) = get_parser().parse_args() - # close listener at exit - atexit.register(get_listener().close) - if options.nofork or os.getuid() == 0: # start GUI - log.start(file = True) # start logging to file + + # close listener at exit + import atexit + atexit.register(get_listener().close) + + logstart(file = True) # start logging to file from .gui import run info("%s v. %s", _("Starting Portato"), VERSION) - if options.shm: - get_listener().set_send(*options.shm) - else: - get_listener().set_send() + get_listener().set_send(options.mq) try: run() @@ -87,14 +87,14 @@ def start(): else: # start us again in root modus and launch listener - import shm_wrapper as shm + from . import ipc + import subprocess, threading + from .su import detect_su_command - mem = shm.create_memory(1024, permissions=0600) - sig = shm.create_semaphore(InitialValue = 0, permissions = 0600) - rw = shm.create_semaphore(InitialValue = 1, permissions = 0600) + mq = ipc.MessageQueue(None, create = True, exclusive = True) # start listener - lt = threading.Thread(target=get_listener().set_recv, args = (mem, sig, rw)) + lt = threading.Thread(target=get_listener().set_recv, args = (mq,)) lt.setDaemon(False) lt.start() @@ -106,7 +106,7 @@ def start(): su = detect_su_command() if su: debug("Using '%s' as su command.", su.bin) - cmd = su.cmd("%s --no-fork --shm %ld %ld %ld" % (sys.argv[0], mem.key, sig.key, rw.key)) + cmd = su.cmd("%s --no-fork --mq %ld" % (sys.argv[0], mq.key)) sp = subprocess.Popen(cmd, env = env) @@ -124,3 +124,9 @@ def start(): if lt.isAlive(): debug("Listener is still running. Close it.") get_listener().close() + lt.join() + + try: + mq.remove() + except ipc.MessageQueueRemovedError: + debug("MessageQueue already removed. Ignore.") diff --git a/portato/backend/system_interface.py b/portato/backend/system_interface.py index 43de1ec..be79de2 100644 --- a/portato/backend/system_interface.py +++ b/portato/backend/system_interface.py @@ -108,8 +108,8 @@ class SystemInterface (object): @param key: the key to look for @type key: string - @param all: the package set to use - @type all: string + @param pkgSet: the package set to use + @type pkgSet: string @param masked: if True, also look for masked packages @type masked: boolean @param with_version: if True, return CPVs - else CP diff --git a/portato/db/__init__.py b/portato/db/__init__.py index da8a81e..60cb1c9 100644 --- a/portato/db/__init__.py +++ b/portato/db/__init__.py @@ -22,7 +22,8 @@ _SESSION = None types = { "sql": (_("SQLite"), _("Uses an SQLite-database to store package information.\nMay take longer to generate at the first time, but has advantages if portato is re-started with an unchanged portage tree. Additionally it allows to use fast SQL expressions for fetching the data.")), - "dict": (_("Hashmap"), _("Uses an in-memory hashmap to store package information.\nHas been used since at least version 0.3.3, but all information has to be regenerated on each startup.")) + "dict": (_("Hashmap"), _("Uses an in-memory hashmap to store package information.\nHas been used since at least version 0.3.3, but all information has to be regenerated on each startup.")), + "eixsql" : (_("eix + SQLite"), _("Similar to SQLite, but now uses the eix database to get the package information.\nThis should be much faster on startup, but requires that your eix database is always up-to-date.")) } def Database(type): @@ -37,16 +38,26 @@ def Database(type): try: from .sql import SQLDatabase except ImportError: - warning(_("Cannot load SQLDatabase.")) + warning(_("Cannot load %s."), "SQLDatabase") return Database("dict") else: - return SQLDatabase(SectionDict(_SESSION, "SQL")) + return SQLDatabase(SectionDict(_SESSION, type)) elif type == "dict": - debug("Using DictDatabase") - from .dict import DictDatabase - return DictDatabase(SectionDict(_SESSION, "dict")) + debug("Using HashDatabase") + from .hash import HashDatabase + return HashDatabase(SectionDict(_SESSION, type)) + elif type == "eixsql": + debug("Using EixSQLDatabase") + try: + from .eix_sql import EixSQLDatabase + except ImportError: + warning(_("Cannot load %s."), "EixSQLDatabase.") + return Database("sql") + else: + return EixSQLDatabase(SectionDict(_SESSION, type)) + else: error(_("Unknown database type: %s"), type) raise UnknownDatabaseTypeError, type diff --git a/portato/db/eix_sql.py b/portato/db/eix_sql.py new file mode 100644 index 0000000..3a0c6e9 --- /dev/null +++ b/portato/db/eix_sql.py @@ -0,0 +1,65 @@ +# -*- coding: utf-8 -*- +# +# File: portato/db/eix_sql.py +# This file is part of the Portato-Project, a graphical portage-frontend. +# +# Copyright (C) 2006-2009 René 'Necoro' Neumann +# This is free software. You may redistribute copies of it under the terms of +# the GNU General Public License version 2. +# There is NO WARRANTY, to the extent permitted by law. +# +# Written by René 'Necoro' Neumann <necoro@necoro.net> + +from __future__ import absolute_import, with_statement + +try: + import sqlite3 as sql +except ImportError: + from pysqlite2 import dbapi2 as sql + +import os + +from .sql import SQLDatabase +from ..eix import EixReader +from ..helper import debug, warning +from ..backend import system + +class EixSQLDatabase (SQLDatabase): + + CACHE_FILE = "/var/cache/eix" + + def __init__ (self, session): + + self.cache = session.get("cache", self.CACHE_FILE) + if not os.path.exists(self.cache): + warning(_("Cache file '%s' does not exist. Using default instead."), self.cache) + self.cache = self.CACHE_FILE + + debug("Using '%s' as eix cache file.", self.cache) + + session["cache"] = self.cache + + SQLDatabase.__init__(self, session) + + def updated (self): + mtime = os.stat(self.cache).st_mtime + old = self.session.get("mtime", 0) + + self.session["mtime"] = str(mtime) + + return old < mtime + + @SQLDatabase.con + def populate (self, category = None, connection = None): + inst = set(system.find_packages(pkgSet = system.SET_INSTALLED, key = category, with_version = False)) + + def _get(): + with EixReader(self.cache) as eix: + for cat in eix.categories: + if category is None or cat.name == category: + for pkg in cat.packages: + p = "%s/%s" % (cat.name, pkg.name) + yield (cat.name, pkg.name, p in inst, False) + + connection.executemany("INSERT INTO packages (cat, name, inst, disabled) VALUES (?, ?, ?, ?)", _get()) + connection.commit() diff --git a/portato/db/dict.py b/portato/db/hash.py index 279ab97..8cea6f2 100644 --- a/portato/db/dict.py +++ b/portato/db/hash.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# File: portato/db/dict.py +# File: portato/db/hash.py # This file is part of the Portato-Project, a graphical portage-frontend. # # Copyright (C) 2006-2009 René 'Necoro' Neumann @@ -19,7 +19,7 @@ from ..helper import info from ..backend import system from .database import Database, PkgData -class DictDatabase (Database): +class HashDatabase (Database): """An internal database which holds a simple dictionary cat -> [package_list].""" lock = Database.lock diff --git a/portato/db/sql.py b/portato/db/sql.py index db66764..e79a27d 100644 --- a/portato/db/sql.py +++ b/portato/db/sql.py @@ -166,7 +166,7 @@ class SQLDatabase (Database): def populate (self, category = None, connection = None): def _get(): # get the lists - inst = system.find_packages(pkgSet = system.SET_INSTALLED, key=category, with_version = False) + inst = set(system.find_packages(pkgSet = system.SET_INSTALLED, key=category, with_version = False)) for p in system.find_packages(key = category, with_version = False): cat, pkg = p.split("/") @@ -247,3 +247,4 @@ class SQLDatabase (Database): self._restrict = "AND (name LIKE '%%%(restrict)s%%' OR cat LIKE '%(restrict)s%%')" % {"restrict":restrict} restrict = property(get_restrict, set_restrict) + con = staticmethod(con) diff --git a/portato/eix/__init__.py b/portato/eix/__init__.py new file mode 100644 index 0000000..346fe82 --- /dev/null +++ b/portato/eix/__init__.py @@ -0,0 +1,88 @@ +# -*- coding: utf-8 -*- +# +# File: portato/eix/__init__.py +# This file is part of the Portato-Project, a graphical portage-frontend. +# +# Copyright (C) 2006-2009 René 'Necoro' Neumann +# This is free software. You may redistribute copies of it under the terms of +# the GNU General Public License version 2. +# There is NO WARRANTY, to the extent permitted by law. +# +# Written by René 'Necoro' Neumann <necoro@necoro.net> + +""" +A module to parse the eix-cache files. +""" + +from __future__ import absolute_import, with_statement +__docformat__ = "restructuredtext" + +from . import parser +from .exceptions import UnsupportedVersionError + +from ..helper import debug + +class EixReader(object): + """ + The main class to use to have access to the eix-cache. + + Note that the file used internally stays open during the whole operation. + So please call `close()` when you are finished. + + The ``EixReader`` supports the context manager protocol, so you can the ``with ... as ...``. + + :CVariables: + + supported_versions : int[] + The list of versions of the eix-cache, which are supported by this reader. + + :IVariables: + + file : file + The eix cache file. + + header : `parser.header` + The header of the eix cache. + + categories : `parser.category` [] + The list of categories. + """ + + supported_versions = (28,) + + def __init__ (self, filename): + """ + :param filename: Path to the cache file + :type filename: string + """ + + self.file = open(filename, "r") + + try: + version = parser.number(self.file) + + if version not in self.supported_versions: + raise UnsupportedVersionError(self.version) + + debug("Started EixReader for version %s.", version) + + self.file.seek(0) + + self.header = parser.header(self.file) + self.categories = parser.vector(self.file, parser.category, nelems = self.header.ncats) + except: + self.close() + raise + + def __enter__ (self): + return self + + def __exit__ (self, exc_type, exc_val, exc_tb): + self.close() + + def close (self): + """ + Closes the cache file. + """ + self.file.close() + debug("EixReader closed.") diff --git a/portato/eix/eix-format.html b/portato/eix/eix-format.html new file mode 100644 index 0000000..ee77458 --- /dev/null +++ b/portato/eix/eix-format.html @@ -0,0 +1,855 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" /> +<title>eix - index file format</title> +<meta name="authors" content="Martin Väth <vaeth AT mathematik DOT uni-wuerzburg DOT de> (active) Emil Beinroth <emilbeinroth AT gmx DOT net> (active) Wolfgang Frisch <xororand AT users DOT sourceforge DOT net> (inactive)" /> +<meta name="copyright" content="This file is part of the eix project and distributed under the terms of the GNU General Public License v2." /> +<style type="text/css"> + +/* +:Author: David Goodger (goodger@python.org) +:Id: $Id: html4css1.css 5196 2007-06-03 20:25:28Z wiemann $ +:Copyright: This stylesheet has been placed in the public domain. + +Default cascading style sheet for the HTML output of Docutils. + +See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to +customize this style sheet. +*/ + +/* used to remove borders from tables and images */ +.borderless, table.borderless td, table.borderless th { + border: 0 } + +table.borderless td, table.borderless th { + /* Override padding for "table.docutils td" with "! important". + The right padding separates the table cells. */ + padding: 0 0.5em 0 0 ! important } + +.first { + /* Override more specific margin styles with "! important". */ + margin-top: 0 ! important } + +.last, .with-subtitle { + margin-bottom: 0 ! important } + +.hidden { + display: none } + +a.toc-backref { + text-decoration: none ; + color: black } + +blockquote.epigraph { + margin: 2em 5em ; } + +dl.docutils dd { + margin-bottom: 0.5em } + +/* Uncomment (and remove this text!) to get bold-faced definition list terms +dl.docutils dt { + font-weight: bold } +*/ + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.admonition p.admonition-title, div.hint p.admonition-title, +div.important p.admonition-title, div.note p.admonition-title, +div.tip p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +/* Uncomment (and remove this text!) to get reduced vertical space in + compound paragraphs. +div.compound .compound-first, div.compound .compound-middle { + margin-bottom: 0.5em } + +div.compound .compound-last, div.compound .compound-middle { + margin-top: 0.5em } +*/ + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em ; + margin-right: 2em } + +div.footer, div.header { + clear: both; + font-size: smaller } + +div.line-block { + display: block ; + margin-top: 1em ; + margin-bottom: 1em } + +div.line-block div.line-block { + margin-top: 0 ; + margin-bottom: 0 ; + margin-left: 1.5em } + +div.sidebar { + margin: 0 0 0.5em 1em ; + border: medium outset ; + padding: 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, +h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { + margin-top: 0.4em } + +h1.title { + text-align: center } + +h2.subtitle { + text-align: center } + +hr.docutils { + width: 75% } + +img.align-left { + clear: left } + +img.align-right { + clear: right } + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font-family: serif ; + font-size: 100% } + +pre.literal-block, pre.doctest-block { + margin-left: 2em ; + margin-right: 2em } + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +span.section-subtitle { + /* font-size relative to parent (h1..h6 element) */ + font-size: 80% } + +table.citation { + border-left: solid 1px gray; + margin-left: 1px } + +table.docinfo { + margin: 2em 4em } + +table.docutils { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.footnote { + border-left: solid 1px black; + margin-left: 1px } + +table.docutils td, table.docutils th, +table.docinfo td, table.docinfo th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +table.docutils th.field-name, table.docinfo th.docinfo-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap ; + padding-left: 0 } + +h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, +h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { + font-size: 100% } + +ul.auto-toc { + list-style-type: none } + +</style> +</head> +<body> +<div class="document" id="eix-index-file-format"> +<h1 class="title">eix - index file format</h1> +<table class="docinfo" frame="void" rules="none"> +<col class="docinfo-name" /> +<col class="docinfo-content" /> +<tbody valign="top"> +<tr><th class="docinfo-name">Authors:</th> +<td>Martin Väth <vaeth AT mathematik DOT uni-wuerzburg DOT de> (active) +<br />Emil Beinroth <emilbeinroth AT gmx DOT net> (active) +<br />Wolfgang Frisch <xororand AT users DOT sourceforge DOT net> (inactive)</td></tr> +<tr><th class="docinfo-name">Copyright:</th> +<td>This file is part of the eix project and distributed under the +terms of the GNU General Public License v2.</td></tr> +</tbody> +</table> +<p>This article describes the format of the eix index file, usually located at /var/cache/eix. The +format includes a version field in the <a class="reference internal" href="#header">header</a> block. The current version is <strong>28</strong> (eix 0.17.0).</p> +<div class="contents topic" id="table-of-contents"> +<p class="topic-title first"><strong>Table of Contents</strong>:</p> +<ul class="simple"> +<li><a class="reference internal" href="#overall-layout" id="id3">Overall layout</a></li> +<li><a class="reference internal" href="#basic-datatypes" id="id4">Basic Datatypes</a><ul> +<li><a class="reference internal" href="#number" id="id5">Number</a></li> +<li><a class="reference internal" href="#vector" id="id6">Vector</a></li> +<li><a class="reference internal" href="#string" id="id7">String</a></li> +<li><a class="reference internal" href="#hash" id="id8">Hash</a></li> +<li><a class="reference internal" href="#hashedstring" id="id9">HashedString</a></li> +<li><a class="reference internal" href="#hashedwords" id="id10">HashedWords</a></li> +</ul> +</li> +<li><a class="reference internal" href="#data-blocks" id="id11">Data blocks</a><ul> +<li><a class="reference internal" href="#header" id="id12">Header</a></li> +<li><a class="reference internal" href="#overlay" id="id13">Overlay</a></li> +<li><a class="reference internal" href="#category" id="id14">Category</a></li> +<li><a class="reference internal" href="#package" id="id15">Package</a></li> +<li><a class="reference internal" href="#version" id="id16">Version</a></li> +<li><a class="reference internal" href="#versionpart" id="id17">VersionPart</a></li> +</ul> +</li> +<li><a class="reference internal" href="#historical-notes" id="id18">Historical notes</a></li> +</ul> +</div> +<div class="section" id="overall-layout"> +<h1>Overall layout</h1> +<p>The file is made up of blocks of data, +which may in turn contain other other blocks. <a class="footnote-reference" href="#vector-vs-blocks" id="id1">[1]</a> +The first block is a special header. +The remaining blocks are the categories which in turn contain the package blocks +which contain the version blocks, ...</p> +<blockquote> +<div class="layout-block header-block container"> +<a class="reference internal" href="#header">Header</a></div> +<div class="layout-block category-block container"> +<p>1st <a class="reference internal" href="#category">Category</a></p> +<div class="layout-block package-block container"> +<p>1st <a class="reference internal" href="#package">Package</a> in 1st Category</p> +<div class="layout-block version-block container"> +1st <a class="reference internal" href="#version">Version</a> of this Package</div> +<div class="layout-block version-block container"> +[..]</div> +</div> +<div class="layout-block package-block container"> +<p>2nd <a class="reference internal" href="#package">Package</a> in 1st Category</p> +<p>[..]</p> +</div> +</div> +<div class="layout-block category-block container"> +<p>2nd <a class="reference internal" href="#category">Category</a></p> +<p>[..]</p> +</div> +</blockquote> +<table class="docutils footnote" frame="void" id="vector-vs-blocks" rules="none"> +<colgroup><col class="label" /><col /></colgroup> +<tbody valign="top"> +<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>Most blocks here occur as a <cite>vector</cite> (described below), i.e. the +first entry is the number of elements, followed by the individual elements. +However, if not stated explicitly that a block is a <cite>vector</cite>, it is +indicated otherwise in the file how many elements it has. +For example, the number of category blocks is contained in the <a class="reference internal" href="#header">header</a>.</td></tr> +</tbody> +</table> +</div> +<div class="section" id="basic-datatypes"> +<h1>Basic Datatypes</h1> +<p>This section covers the datatypes <cite>number</cite> and <cite>vector</cite> (resp. <cite>string</cite>) which are used in the index file.</p> +<div class="section" id="number"> +<h2>Number</h2> +<p>The index file contains non-negative integer values only. The format we use avoids fixed length +integers by encoding the number of bytes into the integer itself. It has a bias towards numbers +smaller than 0xFF, which are encoded into a single byte.</p> +<blockquote> +<p>To determine the number of bytes used, you must first count how often the byte <strong>0xFF</strong> occurs at +the beginning of the number. +Let <cite>n</cite> be this count (<cite>n</cite> may be 0). Then, as a rule, there will follow <cite>n+1</cite> bytes that +contain the actual integer stored in big-endian byte order (highest byte first).</p> +<p><em>But</em> since it would be impossible to store any number that has a leading 0xFF with this format, +a leading 0xFF is stored as 0x00. Meaning, if a 0x00 byte follows the last 0xFF, you must +interpret this byte as 0xFF inside the number.</p> +</blockquote> +<p>Examples:</p> +<blockquote> +<table border="1" class="docutils"> +<colgroup> +<col width="23%" /> +<col width="77%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Number</th> +<th class="head">Bytes stored in the file</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td>0x00</td> +<td>0x00</td> +</tr> +<tr><td>0xFE</td> +<td>0xFE</td> +</tr> +<tr><td>0xFF</td> +<td>0xFF 0x00</td> +</tr> +<tr><td>0x0100</td> +<td>0xFF 0x01 0x00</td> +</tr> +<tr><td>0x01FF</td> +<td>0xFF 0x01 0xFF</td> +</tr> +<tr><td>0xFEFF</td> +<td>0xFF 0xFE 0xFF</td> +</tr> +<tr><td>0xFF00</td> +<td>0xFF 0xFF 0x00 0x00</td> +</tr> +<tr><td>0xFF01</td> +<td>0xFF 0xFF 0x00 0x01</td> +</tr> +<tr><td>0x010000</td> +<td>0xFF 0xFF 0x01 0x00 0x00</td> +</tr> +<tr><td>0xABCDEF</td> +<td>0xFF 0xFF 0xAB 0xCD 0xEF</td> +</tr> +<tr><td>0xFFABCD</td> +<td>0xFF 0xFF 0xFF 0x00 0xAB 0xCD</td> +</tr> +<tr><td>0x01ABCDEF</td> +<td>0xFF 0xFF 0xFF 0x01 0xAB 0xCD 0xEF</td> +</tr> +</tbody> +</table> +</blockquote> +</div> +<div class="section" id="vector"> +<h2>Vector</h2> +<p>Vectors (or lists) are extensively used throughout the index file. They are stored as the <a class="reference internal" href="#number">number</a> of +elements, followed by the elements themselves.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="80%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Type</th> +<th class="head">Content</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td>Number</td> +<td>Number of elements (<cite>n</cite>)</td> +</tr> +<tr><td></td> +<td>1st element</td> +</tr> +<tr><td></td> +<td>...</td> +</tr> +<tr><td></td> +<td><cite>n</cite>th element</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="string"> +<h2>String</h2> +<p>Strings are stored as a <a class="reference internal" href="#vector">vector</a> of characters. A trailing '\0' is not included.</p> +</div> +<div class="section" id="hash"> +<h2>Hash</h2> +<p>A hash is a <a class="reference internal" href="#vector">vector</a> of <a class="reference internal" href="#string">string</a>s.</p> +</div> +<div class="section" id="hashedstring"> +<h2>HashedString</h2> +<p>A <a class="reference internal" href="#number">number</a> which is considered as an index in the corresponding <a class="reference internal" href="#hash">hash</a>; +0 denotes the first string of the hash, 1 the second, ...</p> +</div> +<div class="section" id="hashedwords"> +<h2>HashedWords</h2> +<p>A <a class="reference internal" href="#vector">vector</a> of <a class="reference internal" href="#hashedstring">HashedString</a>s. +The resulting strings are meant to be concatenated, with spaces as separators.</p> +</div> +</div> +<div class="section" id="data-blocks"> +<h1>Data blocks</h1> +<div class="section" id="header"> +<h2>Header</h2> +<table border="1" class="docutils"> +<colgroup> +<col width="19%" /> +<col width="81%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Type</th> +<th class="head">Content</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td>Number</td> +<td>File format version</td> +</tr> +<tr><td>Number</td> +<td>Number of <a class="reference internal" href="#category">Category</a> blocks</td> +</tr> +<tr><td>Vector</td> +<td><a class="reference internal" href="#overlay">Overlay</a>s</td> +</tr> +<tr><td>Hash</td> +<td>Hash for "Provide"</td> +</tr> +<tr><td>Hash</td> +<td>Hash for "Licenses"</td> +</tr> +<tr><td>Hash</td> +<td>Hash for "Keywords"</td> +</tr> +<tr><td>Hash</td> +<td>Hash for "Useflags"</td> +</tr> +<tr><td>Hash</td> +<td>Hash for "Slot"</td> +</tr> +<tr><td>Vector</td> +<td>names of world sets</td> +</tr> +</tbody> +</table> +<p>The names of world sets are the names (without leading @) of th |