Simple manual page reader in Qt
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

115 lines
2.9 KiB

* Copyright (C) 2011-2019 David Sugar <>.
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <>.
#ifndef INDEX_HPP_
#define INDEX_HPP_
#include <QAbstractTableModel>
#include <QString>
#include <QObject>
#include <QMap>
#include <QList>
#include <QStringList>
#include <QAction>
#include <QThread>
#include "compiler.hpp"
class Index final : public QAbstractTableModel
enum Compression {NONE, GZIP};
using item_t = struct {
QString name;
QString section;
Compression compressed;
int path;
char id;
Index(QAction *sections[], const QStringList &paths);
~Index() final;
void start() {
QString nameAt(int row) const;
const item_t& itemAt(int row) const;
int search(const QString& name) const;
int find(const QString& name) const;
void selectAt(int pos, const QString& name);
QAction **savedSections;
QStringList savedPaths;
QList<item_t> items;
bool triggered;
int rows, first, last;
int *map;
inline QString nameFrom(int pos) const {
return items[map[pos]].name + "." + items[map[pos]].section;
inline QString findFrom(int pos, int len) const {
return items[map[pos]].name.left(len);
void scan();
int rowCount(const QModelIndex& parent) const final;
int columnCount(const QModelIndex& parent) const final;
QVariant data(const QModelIndex &index, int role) const final;
QVariant headerData(int section, Qt::Orientation orientation, int role) const final;
void selected(const QString& text);
void updateStatus(const QString& text);
void updateIndex(Index *result);
void finished();
* Data model for index of manual pages.
* \file index.hpp
* \class Index
* \brief Index data model of manual page files.
* This is a model to load and access manual pages. It contains a list of
* files, what manual section they belong to, and the ui name to show them as.
* \author David Sugar <>
* \typedef Index::item_t
* Individual manual page item node.
* \enum Index::Compression
* The file compression used for the file being referenced.
* \var Index::NONE
* \brief No file compression used.
* \var Index::GZIP
* \brief Gzip file compression used.