/usr/include/FlightCrew/flightcrew.h is in libflightcrew-dev 0.7.2+dfsg-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /************************************************************************
**
** Copyright (C) 2010 Strahinja Markovic
**
** This file is part of FlightCrew.
**
** FlightCrew is free software: you can redistribute it and/or modify
** it under the terms of the GNU Lesser General Public License as published
** by the Free Software Foundation, either version 3 of the License, or
** (at your option) any later version.
**
** FlightCrew is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public License
** along with FlightCrew. If not, see <http://www.gnu.org/licenses/>.
**
*************************************************************************/
#pragma once
#ifndef FLIGHTCREW_H
#define FLIGHTCREW_H
#include <vector>
#include <string>
#include "DllExporting.h"
#include "Result.h"
#include "exception.h"
namespace FlightCrew
{
/**
* Validates the provided epub file, running all the checks that FlightCrew
* can perform. This includes all the OPF, NCX, XHTML and CSS checks.
*
* @param filepath A UTF-8 encoded path to the epub file to validate.
* The path can be either absolute or relative to the
* current working directory.
* @return A vector of Results, sorted by internal file and then by line number.
*/
FC_WIN_DLL_API std::vector< Result > ValidateEpub( const std::string &filepath );
/**
* Same as ValidateEpub(), except that it accepts a path to the root folder of an
* already extracted epub publication.
*
* @param filepath A UTF-8 encoded path to the epub root folder to validate.
* The path can be either absolute or relative to the
* current working directory.
* @return A vector of Results, sorted by internal file and then by line number.
*/
FC_WIN_DLL_API std::vector< Result > ValidateEpubRootFolder( const std::string &root_folder_path );
/**
* Validates the provided OPF file of an epub. The files that are listed in the
* OPF are expected to exist.
*
* @param filepath A UTF-8 encoded path to the OPF file to validate.
* The path can be either absolute or relative to the
* current working directory.
* @return A vector of Results, sorted by internal file and then by line number.
*/
FC_WIN_DLL_API std::vector< Result > ValidateOpf( const std::string &filepath );
/**
* Validates the provided NCX file of an epub. The files that are listed in the
* NCX are expected to exist.
*
* @param filepath A UTF-8 encoded path to the NCX file to validate.
* The path can be either absolute or relative to the
* current working directory.
* @return A vector of Results, sorted by internal file and then by line number.
*/
FC_WIN_DLL_API std::vector< Result > ValidateNcx( const std::string &filepath );
/**
* Validates the provided XHTML file of an epub. The resources linked from the file
* are expected to exist.
*
* @param filepath A UTF-8 encoded path to the XHTML file to validate.
* The path can be either absolute or relative to the
* current working directory.
* @return A vector of Results, sorted by internal file and then by line number.
*/
FC_WIN_DLL_API std::vector< Result > ValidateXhtml( const std::string &filepath );
/**
* Validates the provided CSS file of an epub. The resources linked from the file
* are expected to exist. NOTE: this function is currently a stub. It doesn't really
* do anything (yet).
*
* @param filepath A UTF-8 encoded path to the CSS file to validate.
* The path can be either absolute or relative to the
* current working directory.
* @return A vector of Results, sorted by internal file and then by line number.
*/
FC_WIN_DLL_API std::vector< Result > ValidateCss( const std::string &filepath );
} // namespace FlightCrew
#endif // FLIGHTCREW_H
|