Initial commit
This is essentially a gutted fork of nncmpp that doesn't do anything.
This commit is contained in:
commit
d0eee678b5
9
.gitignore
vendored
Normal file
9
.gitignore
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
# Build files
|
||||
/build
|
||||
|
||||
# Qt Creator files
|
||||
/CMakeLists.txt.user*
|
||||
/hex.config
|
||||
/hex.files
|
||||
/hex.creator*
|
||||
/hex.includes
|
6
.gitmodules
vendored
Normal file
6
.gitmodules
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
[submodule "termo"]
|
||||
path = termo
|
||||
url = git://github.com/pjanouch/termo.git
|
||||
[submodule "liberty"]
|
||||
path = liberty
|
||||
url = git://github.com/pjanouch/liberty.git
|
116
CMakeLists.txt
Normal file
116
CMakeLists.txt
Normal file
@ -0,0 +1,116 @@
|
||||
project (hex C)
|
||||
cmake_minimum_required (VERSION 2.8.5)
|
||||
|
||||
# Moar warnings
|
||||
if ("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR CMAKE_COMPILER_IS_GNUC)
|
||||
set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99")
|
||||
set (CMAKE_C_FLAGS_DEBUG
|
||||
"${CMAKE_C_FLAGS_DEBUG} -Wall -Wextra -Wno-unused-function")
|
||||
endif ("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR CMAKE_COMPILER_IS_GNUC)
|
||||
|
||||
# Version
|
||||
set (project_VERSION_MAJOR "0")
|
||||
set (project_VERSION_MINOR "1")
|
||||
set (project_VERSION_PATCH "0")
|
||||
|
||||
set (project_VERSION "${project_VERSION_MAJOR}")
|
||||
set (project_VERSION "${project_VERSION}.${project_VERSION_MINOR}")
|
||||
set (project_VERSION "${project_VERSION}.${project_VERSION_PATCH}")
|
||||
|
||||
# For custom modules
|
||||
set (CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
|
||||
|
||||
# Dependencies
|
||||
find_package (Ncursesw REQUIRED)
|
||||
find_package (PkgConfig REQUIRED)
|
||||
find_package (Unistring REQUIRED)
|
||||
|
||||
set (CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/liberty/cmake)
|
||||
include (AddThreads)
|
||||
|
||||
find_package (Termo QUIET NO_MODULE)
|
||||
option (USE_SYSTEM_TERMO
|
||||
"Don't compile our own termo library, use the system one" ${Termo_FOUND})
|
||||
|
||||
if (USE_SYSTEM_TERMO)
|
||||
if (NOT Termo_FOUND)
|
||||
message (FATAL_ERROR "System termo library not found")
|
||||
endif (NOT Termo_FOUND)
|
||||
else (USE_SYSTEM_TERMO)
|
||||
add_subdirectory (termo EXCLUDE_FROM_ALL)
|
||||
# We don't have many good choices when we don't want to install it and want
|
||||
# to support older versions of CMake; this is a relatively clean approach
|
||||
# (other possibilities: setting a variable in the parent scope, using a
|
||||
# cache variable, writing a special config file with build paths in it and
|
||||
# including it here, or setting a custom property on the targets).
|
||||
get_directory_property (Termo_INCLUDE_DIRS
|
||||
DIRECTORY termo INCLUDE_DIRECTORIES)
|
||||
set (Termo_LIBRARIES termo-static)
|
||||
endif (USE_SYSTEM_TERMO)
|
||||
|
||||
include_directories (${UNISTRING_INCLUDE_DIRS}
|
||||
${NCURSESW_INCLUDE_DIRS} ${Termo_INCLUDE_DIRS})
|
||||
|
||||
# Configuration
|
||||
include (CheckFunctionExists)
|
||||
set (CMAKE_REQUIRED_LIBRARIES ${NCURSESW_LIBRARIES})
|
||||
CHECK_FUNCTION_EXISTS ("resizeterm" HAVE_RESIZETERM)
|
||||
|
||||
# Generate a configuration file
|
||||
configure_file (${PROJECT_SOURCE_DIR}/config.h.in
|
||||
${PROJECT_BINARY_DIR}/config.h)
|
||||
include_directories (${PROJECT_SOURCE_DIR} ${PROJECT_BINARY_DIR})
|
||||
|
||||
# Build the main executable and link it
|
||||
add_executable (${PROJECT_NAME} ${PROJECT_NAME}.c)
|
||||
target_link_libraries (${PROJECT_NAME} ${UNISTRING_LIBRARIES}
|
||||
${NCURSESW_LIBRARIES} termo-static)
|
||||
add_threads (${PROJECT_NAME})
|
||||
|
||||
# Installation
|
||||
include (GNUInstallDirs)
|
||||
install (TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR})
|
||||
install (FILES LICENSE DESTINATION ${CMAKE_INSTALL_DOCDIR})
|
||||
|
||||
# Generate documentation from program help
|
||||
find_program (HELP2MAN_EXECUTABLE help2man)
|
||||
if (NOT HELP2MAN_EXECUTABLE)
|
||||
message (FATAL_ERROR "help2man not found")
|
||||
endif (NOT HELP2MAN_EXECUTABLE)
|
||||
|
||||
foreach (page ${PROJECT_NAME})
|
||||
set (page_output "${PROJECT_BINARY_DIR}/${page}.1")
|
||||
list (APPEND project_MAN_PAGES "${page_output}")
|
||||
add_custom_command (OUTPUT ${page_output}
|
||||
COMMAND ${HELP2MAN_EXECUTABLE} -N
|
||||
"${PROJECT_BINARY_DIR}/${page}" -o ${page_output}
|
||||
DEPENDS ${page}
|
||||
COMMENT "Generating man page for ${page}" VERBATIM)
|
||||
endforeach (page)
|
||||
|
||||
add_custom_target (docs ALL DEPENDS ${project_MAN_PAGES})
|
||||
|
||||
foreach (page ${project_MAN_PAGES})
|
||||
string (REGEX MATCH "\\.([0-9])$" manpage_suffix "${page}")
|
||||
install (FILES "${page}"
|
||||
DESTINATION "${CMAKE_INSTALL_MANDIR}/man${CMAKE_MATCH_1}")
|
||||
endforeach (page)
|
||||
|
||||
# CPack
|
||||
set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Hex viewer")
|
||||
set (CPACK_PACKAGE_VENDOR "Premysl Janouch")
|
||||
set (CPACK_PACKAGE_CONTACT "Přemysl Janouch <p.janouch@gmail.com>")
|
||||
set (CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE")
|
||||
set (CPACK_PACKAGE_VERSION_MAJOR ${project_VERSION_MAJOR})
|
||||
set (CPACK_PACKAGE_VERSION_MINOR ${project_VERSION_MINOR})
|
||||
set (CPACK_PACKAGE_VERSION_PATCH ${project_VERSION_PATCH})
|
||||
set (CPACK_GENERATOR "TGZ;ZIP")
|
||||
set (CPACK_PACKAGE_FILE_NAME
|
||||
"${PROJECT_NAME}-${project_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
|
||||
set (CPACK_PACKAGE_INSTALL_DIRECTORY "${PROJECT_NAME}-${project_VERSION}")
|
||||
set (CPACK_SOURCE_GENERATOR "TGZ;ZIP")
|
||||
set (CPACK_SOURCE_IGNORE_FILES "/\\\\.git;/build;/CMakeLists.txt.user")
|
||||
set (CPACK_SOURCE_PACKAGE_FILE_NAME "${PROJECT_NAME}-${project_VERSION}")
|
||||
|
||||
set (CPACK_SET_DESTDIR TRUE)
|
||||
include (CPack)
|
15
LICENSE
Normal file
15
LICENSE
Normal file
@ -0,0 +1,15 @@
|
||||
Copyright (c) 2016, Přemysl Janouch <p.janouch@gmail.com>
|
||||
All rights reserved.
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any
|
||||
purpose with or without fee is hereby granted, provided that the above
|
||||
copyright notice and this permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
|
||||
SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
|
||||
OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
||||
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
|
86
README.adoc
Normal file
86
README.adoc
Normal file
@ -0,0 +1,86 @@
|
||||
hex
|
||||
===
|
||||
|
||||
'hex' is yet another hex viewer. As of now, there are no advantages to it.
|
||||
|
||||
Plans
|
||||
-----
|
||||
In the future, it should be able to automatically interpret fields within files
|
||||
via a set of Lua scripts.
|
||||
|
||||
Packages
|
||||
--------
|
||||
Regular releases are sporadic. git master should be stable enough. You can get
|
||||
a package with the latest development version from Archlinux's AUR, or from
|
||||
openSUSE Build Service for the rest of mainstream distributions. Consult the
|
||||
list of repositories and their respective links at:
|
||||
|
||||
https://build.opensuse.org/project/repositories/home:pjanouch:git
|
||||
|
||||
Building and Running
|
||||
--------------------
|
||||
Build dependencies: CMake, pkg-config, help2man, liberty (included),
|
||||
termo (included) +
|
||||
Runtime dependencies: ncursesw, libunistring
|
||||
|
||||
$ git clone --recursive https://github.com/pjanouch/hex.git
|
||||
$ mkdir hex/build
|
||||
$ cd hex/build
|
||||
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
|
||||
$ make
|
||||
|
||||
To install the application, you can do either the usual:
|
||||
|
||||
# make install
|
||||
|
||||
Or you can try telling CMake to make a package for you. For Debian it is:
|
||||
|
||||
$ cpack -G DEB
|
||||
# dpkg -i hex-*.deb
|
||||
|
||||
Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with
|
||||
`fakeroot` or file ownership will end up wrong.
|
||||
|
||||
Having the program installed, optionally create a configuration file and run it.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
Create _~/.config/hex/hex.conf_ with contents like the following:
|
||||
|
||||
....
|
||||
colors = {
|
||||
header = ""
|
||||
highlight = "bold"
|
||||
bar = "reverse"
|
||||
bar_active = "ul"
|
||||
even = ""
|
||||
odd = ""
|
||||
selection = "reverse"
|
||||
}
|
||||
....
|
||||
|
||||
Terminal caveats
|
||||
----------------
|
||||
This application aspires to be as close to a GUI as possible. It expects you
|
||||
to use the mouse (though it's not required). Terminals are, however, somewhat
|
||||
tricky to get consistent results on, so be aware of the following:
|
||||
|
||||
- use a UTF-8 locale to get finer resolution progress bars and scrollbars
|
||||
- Xterm needs `XTerm*metaSendsEscape: true` for the default bindings to work
|
||||
- urxvt's 'vtwheel' plugin sabotages scrolling
|
||||
|
||||
Contributing and Support
|
||||
------------------------
|
||||
Use this project's GitHub to report any bugs, request features, or submit pull
|
||||
requests. If you want to discuss this project, or maybe just hang out with
|
||||
the developer, feel free to join me at irc://irc.janouch.name, channel #dev.
|
||||
|
||||
License
|
||||
-------
|
||||
'hex' is written by Přemysl Janouch <p.janouch@gmail.com>.
|
||||
|
||||
You may use the software under the terms of the ISC license, the text of which
|
||||
is included within the package, or, at your option, you may relicense the work
|
||||
under the MIT or the Modified BSD License, as listed at the following site:
|
||||
|
||||
http://www.gnu.org/licenses/license-list.html
|
17
cmake/FindNcursesw.cmake
Normal file
17
cmake/FindNcursesw.cmake
Normal file
@ -0,0 +1,17 @@
|
||||
# Public Domain
|
||||
|
||||
find_package (PkgConfig REQUIRED)
|
||||
pkg_check_modules (NCURSESW QUIET ncursesw)
|
||||
|
||||
# OpenBSD doesn't provide a pkg-config file
|
||||
set (required_vars NCURSESW_LIBRARIES)
|
||||
if (NOT NCURSESW_FOUND)
|
||||
find_library (NCURSESW_LIBRARIES NAMES ncursesw)
|
||||
find_path (NCURSESW_INCLUDE_DIRS ncurses.h)
|
||||
list (APPEND required_vars NCURSESW_INCLUDE_DIRS)
|
||||
endif (NOT NCURSESW_FOUND)
|
||||
|
||||
include (FindPackageHandleStandardArgs)
|
||||
FIND_PACKAGE_HANDLE_STANDARD_ARGS (NCURSESW DEFAULT_MSG ${required_vars})
|
||||
|
||||
mark_as_advanced (NCURSESW_LIBRARIES NCURSESW_INCLUDE_DIRS)
|
10
cmake/FindUnistring.cmake
Normal file
10
cmake/FindUnistring.cmake
Normal file
@ -0,0 +1,10 @@
|
||||
# Public Domain
|
||||
|
||||
find_path (UNISTRING_INCLUDE_DIRS unistr.h)
|
||||
find_library (UNISTRING_LIBRARIES NAMES unistring libunistring)
|
||||
|
||||
include (FindPackageHandleStandardArgs)
|
||||
FIND_PACKAGE_HANDLE_STANDARD_ARGS (UNISTRING DEFAULT_MSG
|
||||
UNISTRING_INCLUDE_DIRS UNISTRING_LIBRARIES)
|
||||
|
||||
mark_as_advanced (UNISTRING_LIBRARIES UNISTRING_INCLUDE_DIRS)
|
10
config.h.in
Normal file
10
config.h.in
Normal file
@ -0,0 +1,10 @@
|
||||
#ifndef CONFIG_H
|
||||
#define CONFIG_H
|
||||
|
||||
#define PROGRAM_NAME "${CMAKE_PROJECT_NAME}"
|
||||
#define PROGRAM_VERSION "${project_VERSION}"
|
||||
|
||||
#cmakedefine HAVE_RESIZETERM
|
||||
|
||||
#endif // ! CONFIG_H
|
||||
|
1
liberty
Submodule
1
liberty
Submodule
@ -0,0 +1 @@
|
||||
Subproject commit f53b717f3bba27ca1c42486d3742c91967f3fe93
|
1
termo
Submodule
1
termo
Submodule
@ -0,0 +1 @@
|
||||
Subproject commit a9b41e41b7789924465a7e5596a463ed93d8fc26
|
Loading…
Reference in New Issue
Block a user