mirror of
https://github.com/boostorg/quickbook.git
synced 2026-01-24 18:12:46 +00:00
147 lines
4.8 KiB
C++
147 lines
4.8 KiB
C++
/*=============================================================================
|
|
Copyright (c) 2009 Daniel James
|
|
|
|
Use, modification and distribution is subject to the Boost Software
|
|
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
|
http://www.boost.org/LICENSE_1_0.txt)
|
|
=============================================================================*/
|
|
|
|
// For handling native strings and streams.
|
|
|
|
#if !defined(BOOST_QUICKBOOK_DETAIL_NATIVE_TEXT_HPP)
|
|
#define BOOST_QUICKBOOK_DETAIL_NATIVE_TEXT_HPP
|
|
|
|
#include <boost/config.hpp>
|
|
#include <boost/filesystem/path.hpp>
|
|
#include "string_view.hpp"
|
|
#include <string>
|
|
#include <stdexcept>
|
|
#include <iostream>
|
|
#include "fwd.hpp"
|
|
|
|
#if defined(__cygwin__) || defined(__CYGWIN__)
|
|
# define QUICKBOOK_CYGWIN_PATHS 1
|
|
#elif defined(_WIN32)
|
|
# define QUICKBOOK_WIDE_PATHS 1
|
|
// Wide streams work okay for me with older versions of Visual C++,
|
|
// but I've had reports of problems. My guess is that it's an
|
|
// incompatibility with later versions of windows.
|
|
# if defined(BOOST_MSVC) && BOOST_MSVC >= 1700
|
|
# define QUICKBOOK_WIDE_STREAMS 1
|
|
# endif
|
|
#endif
|
|
|
|
#if !defined(QUICKBOOK_WIDE_PATHS)
|
|
#define QUICKBOOK_WIDE_PATHS 0
|
|
#endif
|
|
|
|
#if !defined(QUICKBOOK_WIDE_STREAMS)
|
|
#define QUICKBOOK_WIDE_STREAMS 0
|
|
#endif
|
|
|
|
#if !defined(QUICKBOOK_CYGWIN_PATHS)
|
|
#define QUICKBOOK_CYGWIN_PATHS 0
|
|
#endif
|
|
|
|
namespace quickbook
|
|
{
|
|
namespace fs = boost::filesystem;
|
|
|
|
namespace detail
|
|
{
|
|
struct conversion_error : std::runtime_error
|
|
{
|
|
conversion_error(char const* m) : std::runtime_error(m) {}
|
|
};
|
|
|
|
// 'generic': Paths in quickbook source and the generated boostbook.
|
|
// Always UTF-8.
|
|
// 'command_line':
|
|
// Paths (or other parameters) from the command line and
|
|
// possibly other sources in the future. Wide strings on
|
|
// normal windows, UTF-8 for cygwin and other platforms
|
|
// (hopefully).
|
|
// 'path': Stored as a boost::filesystem::path. Since
|
|
// Boost.Filesystem doesn't support cygwin, this
|
|
// is always wide on windows. UTF-8 on other
|
|
// platforms (again, hopefully).
|
|
|
|
#if QUICKBOOK_WIDE_PATHS
|
|
typedef std::wstring command_line_string;
|
|
#else
|
|
typedef std::string command_line_string;
|
|
#endif
|
|
|
|
// A light wrapper around C++'s streams that gets things right
|
|
// in the quickbook context.
|
|
//
|
|
// This is far from perfect but it fixes some issues.
|
|
struct ostream
|
|
{
|
|
#if QUICKBOOK_WIDE_STREAMS
|
|
typedef std::wostream base_ostream;
|
|
typedef std::wios base_ios;
|
|
typedef std::wstring string;
|
|
typedef boost::wstring_view string_ref;
|
|
#else
|
|
typedef std::ostream base_ostream;
|
|
typedef std::ios base_ios;
|
|
typedef std::string string;
|
|
typedef quickbook::string_view string_ref;
|
|
#endif
|
|
base_ostream& base;
|
|
|
|
explicit ostream(base_ostream& x) : base(x) {}
|
|
|
|
// C strings should always be ascii.
|
|
ostream& operator<<(char);
|
|
ostream& operator<<(char const*);
|
|
|
|
// std::string should be UTF-8 (what a mess!)
|
|
ostream& operator<<(std::string const&);
|
|
ostream& operator<<(quickbook::string_view);
|
|
|
|
// Other value types.
|
|
ostream& operator<<(int x);
|
|
ostream& operator<<(unsigned int x);
|
|
ostream& operator<<(long x);
|
|
ostream& operator<<(unsigned long x);
|
|
|
|
#if !defined(BOOST_NO_LONG_LONG)
|
|
ostream& operator<<(long long x);
|
|
ostream& operator<<(unsigned long long x);
|
|
#endif
|
|
|
|
ostream& operator<<(fs::path const&);
|
|
|
|
// Modifiers
|
|
ostream& operator<<(base_ostream& (*)(base_ostream&));
|
|
ostream& operator<<(base_ios& (*)(base_ios&));
|
|
};
|
|
|
|
|
|
std::string command_line_to_utf8(command_line_string const&);
|
|
fs::path command_line_to_path(command_line_string const&);
|
|
|
|
std::string path_to_generic(fs::path const&);
|
|
fs::path generic_to_path(quickbook::string_view);
|
|
|
|
void initialise_output();
|
|
|
|
ostream& out();
|
|
|
|
// Preformats an error/warning message so that it can be parsed by
|
|
// common IDEs. Set 'ms_errors' to determine if VS format
|
|
// or GCC format. Returns the stream to continue ouput of the verbose
|
|
// error message.
|
|
void set_ms_errors(bool);
|
|
ostream& outerr();
|
|
ostream& outerr(fs::path const& file, int line = -1);
|
|
ostream& outwarn(fs::path const& file, int line = -1);
|
|
ostream& outerr(file_ptr const&, string_iterator);
|
|
ostream& outwarn(file_ptr const&, string_iterator);
|
|
}
|
|
}
|
|
|
|
#endif
|