Awesome
Travis CI (Linux:gcc, Linux:clang, Mac OS X:clang)
AppVeyor CI (Windows:Clang/C2)
Text_view for range-v3
A range-v3 based character encoding and code point enumeration library.
Text_view for range-v3 is a port of the text_view project to range-v3. See the text_view documentation for more details.
For discussion of this project, please post and/or subscribe to the
text_view@googlegroups.com group hosted at
https://groups.google.com/d/forum/text_view
- Overview
- Current features and limitations
- Requirements
- Build and installation
- Usage
- Supported Encodings
- Terminology
- References
Overview
See the Text_view documentation.
Current features and limitations
See the Text_view documentation.
Requirements
Text_view for range-v3 depends on the range-v3 library and is expected to build and run correctly with any compiler supported by range-v3.
Build and installation
This section provides instructions for building Text_view for range-v3 and suitable versions of its dependencies.
Building and installing range-v3
Text_view for range-v3 only depends on headers provided
by range-v3 and no build or installation is required.
Text_view for range-v3 is known to build successfully with
range-v3 git revision e07976393f8811d06c14cebed111005462a4b98c. The
following commands can be used to checkout a known good revision.
$ git clone https://github.com/ericniebler/range-v3.git range-v3
$ cd range-v3
$ git checkout e07976393f8811d06c14cebed111005462a4b98c
Text_view for range-v3 has a CMake based build system
sufficient to build and run its tests, to validate example code, and to perform
a minimal installation following established operating system conventions. By
default, files will be installed under /usr/local on UNIX and UNIX-like
systems, and under C:\Program Files on Windows. The installation location
can be changed by invoking cmake with a -DCMAKE_INSTALL_PREFIX=<path>
option. On UNIX and UNIX-like systems, header files will be installed in the
include directory of the installation destination, and other files will be
installed under share/text_view. On Windows, header files be installed in
the text_view\include directory of the installation destination, and other
files will be installed under text_view.
Unless range-v3 is installed to a common location, it will be necessary to
inform the build where it is installed. This is typically done by setting the
RANGE_V3_INSTALL_PATH environment variable. As of this writing, range-v3
does not provide an installation option, so RANGE_V3_INSTALL_PATH should
specify the location where the range-v3 source resides (the directory that
contains the range-v3 include directory).
The following commands suffice to build and run tests and examples, and perform
an installation. If the build succeeds, built test and example programs will
be present in the test and examples subdirectories of the build directory
(the built test and example programs are not installed), and header files,
example code, cmake package configuration modules, and other miscellaneous files
will be present in the installation directory.
$ vi setenv.sh # Update RANGE_V3_INSTALL_PATH.
$ . ./setenv.sh
$ mkdir build
$ cd build
$ cmake .. [-DCMAKE_INSTALL_PREFIX=/path/to/install/to]
$ cmake --build . --target install
$ ctest
check and check-install CMake targets are also available for automating
build and test. The check target performs a build without installation and
then runs the tests. The check-install target performs a build, runs tests,
installs to a location within the build directory, and then performs tests
(verifying that example code builds) on the installation.
The installation includes a CMake based build system for building the example
code. To build all of the examples, run cmake specifying the examples
directory of the installation as the source directory. Alternatively, each
example can be built independently by specifying its source directory as the
source directory in a cmake invocation. If the installation was to a
non-default installation location (-DCMAKE_INSTALL_PREFIX was specified),
then it may be necessary to set CMAKE_PREFIX_PATH to the
Text_view for range-v3
installation location (the location CMAKE_INSTALL_PREFIX was set to) or
text_view_range_v3_DIR to the directory containing the installed
text_view_range_v3-config.cmake file, so that the
Text_view for range-v3 package configuration
file is found. See the CMake documentation for more details.
The following commands suffice to build all of the installed examples.
$ cd /path/to/installation/text_view-range-v3/examples
$ mkdir build
$ cd build
$ cmake .. [-DCMAKE_PREFIX_PATH=/path/to/installation]
$ cmake --build .
$ ctest
Usage
Text_view for range-v3 installations include a CMake
package configuration file suitable for use in CMake based projects. To use
it, specify text_view_range_v3 as the <package> argument to find_package
in your CMake file and add invocations of target_link_libraries for each
relevant target with the <lib> argument set to text-view-range-v3. This
will automatically apply compiler and linker options required to use
Text_view for range-v3 to each target. See the
CMakeLists.txt files for the utilities under the examples directory for
reference. If Text_view for range-v3 was installed to a
non-default installation location (-DCMAKE_INSTALL_PREFIX was specified),
then it may be necessary to set CMAKE_PREFIX_PATH to the
Text_view for range-v3 installation location (the location
CMAKE_INSTALL_PREFIX was set to) or text_view_range_v3_DIR to the directory
containing the installed text_view_range_v3-config.cmake file, so that the
Text_view for range-v3 package configuration file is
found. It is also possible to use the build directory as a (non-relocatable)
installation directory by setting The CMAKE_PREFIX_PATH or
text_view_range_v3_DIR variables appropriately. See the CMake documentation
for more details. The CMakeLists.txt files provided with the installed
examples exemplify a minimal CMake based build system for a downstream
consumer of Text_view for range-v3.
See the Text_view documentation for additional details.
Supported Encodings
See the Text_view documentation.
Terminology
See the Text_view documentation.