Skip to content
This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Example: Building Libraries

Jump to bottom
drahosp edited this page Mar 19, 2011 · 1 revision

Building Libraries

Building external dependencies and libraries is not trivial and requires either:

  • that the external dependency has a detailed documentation how to build it
  • you have a good understanding of make tools (autoconf, automake, etc.)
  • external dependencies use some other build tools e.g. SCons, Bakefiles etc. for building

At least moderate knowledge of CMake is recomended. If you fulfill above criteria then all you have to do is:

  • define project name, usually the name of the module
  • include dist.cmake
    • this will set up all variables that contain installation paths
  • check platform/compiler specifics
  • generate a configuration header if needed (requires to write down a template file of the configuration header)
  • instruct CMAKE to search for external dependencies if needed
    • check if external dependencies were found
  • create the library
  • link library against other external dependencies
  • write commands for installing library and other files

Here is an commented example for the Expat library:

Write a configuration template file: expat_config.h.cmake

This file contains defines like this

/* Define to 1 if you have the `bcopy' function. */#cmakedefine HAVE_BCOPY ${HAVE_BCOPY}

and during configuration phase is evaluated to e.g.

#defineHAVE_BCOPY 1

depending whether compiler finds bcopy function.

Write CMakeLists.txt

The following example shows how configuration of headers can be implemented. On some libraries this is obsolete but for the purpose of example we will show a more complex situation.

# Copyright (C) 2007-2011 LuaDist.# Created by Peter Kapec# Redistribution and use of this file is allowed according to the terms of the MIT license.# For details see the COPYRIGHT file distributed with LuaDist.# Please note that the package source code is licensed under its own license.project ( libexpat C ) # projects name# CMake configuration:cmake_minimum_required ( VERSION2.6 )	# set minimum CMake version# Include dist.cmake, this defines install paths and some useful macrosinclude ( dist.cmake )
## Generating expat_config.h file:message ( "Configure: Expat - generating expat_config.h:" )
# include functions for checking stuffinclude (CheckIncludeFiles) # check for headersinclude (CheckFunctionExists)	# check for functionsinclude ( CheckSymbolExists ) # check for symbolsinclude ( TestBigEndian ) # check endiandnesinclude ( CheckTypeSize ) # check size of typestest_big_endian ( ENDIAN_TEST ) # check endiandness and set byte orderif ( ENDIAN_TEST )
set ( BYTEORDER 4321 ) else ()
set ( BYTEORDER 1234 )
endif ()
check_function_exists ( bcopyHAVE_BCOPY )	# check if bcopy existcheck_include_files ( dlfcn.hHAVE_DLFCN_H )	# check if dlfcn.h header existcheck_include_files ( fcntl.hHAVE_FCNTL_H )
check_function_exists ( getpagesizeHAVE_GETPAGESIZE )	# check if function getpagesize existcheck_include_files ( inttypes.hHAVE_INTTYPES_H )
check_function_exists ( memmoveHAVE_MEMMOVE )
check_include_files ( memory.hHAVE_MEMORY_H )
check_function_exists ( mmapHAVE_MMAP )
check_include_files ( stdint.hHAVE_STDINT_H )
check_include_files ( stdlib.hHAVE_STDLIB_H )
check_include_files ( strings.hHAVE_STRINGS_H )
check_include_files ( string.hHAVE_STRING_H )
check_include_files ( "sys/stat.h"HAVE_SYS_STAT_H )
check_include_files ( "sys/types.h"HAVE_SYS_TYPES_H )
check_include_files ( unistd.hHAVE_UNISTD_H )
set ( PACKAGE_BUGREPORT "expat-bugs@libexpat.org" )
set ( PACKAGE_NAME "expat" )
set ( PACKAGE_STRING "expat 2.0.0" )
set ( PACKAGE_TARNAME "expat" )
set ( PACKAGE_VERSION "2.0.0" )
check_include_files ( "stdlib.h;stdarg.h;string.h;float.h"STDC_HEADERS )
#WARNING: Following tests might NOT be the original test as found in original ./configure script!#TODO: Someone has to check it, pliz (I'm not an automake guru).# how to check WORDS_BIGENDIAN ? maybe:set ( WORDS_BIGENDIAN ${ENDIAN_TEST} )
# TODO:#/* Define to __FUNCTION__ or "" if `__func__' does not conform to ANSI C. */#cmakedefine __func__# TODO:#/* Define to empty if `const' does not conform to ANSI C. */#cmakedefine const#/* Define to `long' if <sys/types.h> does not define. */check_type_size ( "off_t"SIZEOF_OFF_T )	# check size of off_tif ( HAVE_SIZEOF_OFF_T )
set (HAVE_OFF_T 1)
else ()
set (HAVE_OFF_T 0)
set (off_t "long")
endif ()
#/* Define to `unsigned' if <sys/types.h> does not define. */check_type_size ( "size_t"SIZEOF_SIZE_T )
if ( HAVE_SIZEOF_SIZE_T )
set ( HAVE_SIZE_T 1 )
else ()
set ( HAVE_SIZE_T 0 )
set ( size_t "unsigned" )
endif ()
# all checks have been tested (all variables from expat_config.h.cmake were set)# so replace all #cmakedefine's in xpat_config.h.cmake with correct waluesconfigure_file ( ${CMAKE_CURRENT_SOURCE_DIR}/expat_config.h.cmake${CMAKE_CURRENT_BINARY_DIR}/expat_config.h ) # CONFIGURE_FILE operates on CONFIGURE_FILE(source_file destination_file) where# source_file - uses ${CMAKE_CURRENT_SOURCE_DIR} path - it is our source dir# destination_file - uses ${CMAKE_CURRENT_BINARY_DIR} path - we are doing out-of-source build, so this won't polute Expat sources message ( "Configure: Expat - done." )
# end of generating expat_config.h file:## Expat library# set include path to include lib directory and our build directory stored in ${CMAKE_CURRENT_BINARY_DIR}include_directories ( lib${CMAKE_CURRENT_BINARY_DIR}) # Expat library consist of these 3 filesset ( SRC_EXPATLIB lib/xmlparse.c lib/xmlrole.c lib/xmltok.c )
# add -DHAVE_EXPAT_CONFIG_H to compiler to tell we have our own expat_config.h fileadd_definitions ( -DHAVE_EXPAT_CONFIG_H )
# create the expat library using source files stored in ${SRC_EXPATLIB} and add .def file stored in ${DEF_FILE} if necessaryadd_library ( expatSHARED${SRC_EXPATLIB}lib/libexpat.def )
install_library ( expat )
install_header ( lib/expat.hlib/expat_external.h )
install_data ( COPYINGChangesREADME )
install_doc ( doc/ )

Note:

This tutorial only some aspects of translating libraries to CMake. It is a guide how to proceed and other libraries may require you to write more complex scripts, especially when you need to select files or compiler flags for platform/copiler specific tests. Please see other libraries providied by LuaDist for examples.

Alternatively you can submit an issue to the Repository Issues if you need help.

Clone this wiki locally

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Example: Building Libraries · LuaDist/Repository Wiki · GitHub
Skip to content

This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Example: Building Libraries
Jump to bottom

drahosp edited this page Mar 19, 2011
·
1 revision
Building Libraries
Building external dependencies and libraries is not trivial and requires either:
  • that the external dependency has a detailed documentation how to build it
  • you have a good understanding of make tools (autoconf, automake, etc.)
  • external dependencies use some other build tools e.g. SCons, Bakefiles etc. for building
At least moderate knowledge of CMake is recomended.
If you fulfill above criteria then all you have to do is:
  • define project name, usually the name of the module
  • include dist.cmake
    • this will set up all variables that contain installation paths
  • check platform/compiler specifics
  • generate a configuration header if needed (requires to write down a template file of the configuration header)
  • instruct CMAKE to search for external dependencies if needed

    • check if external dependencies were found
  • create the library
  • link library against other external dependencies
  • write commands for installing library and other files
Here is an commented example for the Expat library:
Write a configuration template file: expat_config.h.cmake
This file contains defines like this
/* Define to 1 if you have the `bcopy' function. */#cmakedefine HAVE_BCOPY ${HAVE_BCOPY}
and during configuration phase is evaluated to e.g.
#defineHAVE_BCOPY 1
depending whether compiler finds bcopy function.
Write CMakeLists.txt
The following example shows how configuration of headers can be implemented. On some libraries this is obsolete but for the purpose of example we will show a more complex situation.
# Copyright (C) 2007-2011 LuaDist.# Created by Peter Kapec# Redistribution and use of this file is allowed according to the terms of the MIT license.# For details see the COPYRIGHT file distributed with LuaDist.# Please note that the package source code is licensed under its own license.project ( libexpat C ) # projects name# CMake configuration:cmake_minimum_required ( VERSION2.6 )	# set minimum CMake version# Include dist.cmake, this defines install paths and some useful macrosinclude ( dist.cmake )
## Generating expat_config.h file:message ( "Configure: Expat - generating expat_config.h:" )
# include functions for checking stuffinclude (CheckIncludeFiles) # check for headersinclude (CheckFunctionExists)	# check for functionsinclude ( CheckSymbolExists ) # check for symbolsinclude ( TestBigEndian ) # check endiandnesinclude ( CheckTypeSize ) # check size of typestest_big_endian ( ENDIAN_TEST ) # check endiandness and set byte orderif ( ENDIAN_TEST )
set ( BYTEORDER 4321 ) else ()
set ( BYTEORDER 1234 )
endif ()
check_function_exists ( bcopyHAVE_BCOPY )	# check if bcopy existcheck_include_files ( dlfcn.hHAVE_DLFCN_H )	# check if dlfcn.h header existcheck_include_files ( fcntl.hHAVE_FCNTL_H )
check_function_exists ( getpagesizeHAVE_GETPAGESIZE )	# check if function getpagesize existcheck_include_files ( inttypes.hHAVE_INTTYPES_H )
check_function_exists ( memmoveHAVE_MEMMOVE )
check_include_files ( memory.hHAVE_MEMORY_H )
check_function_exists ( mmapHAVE_MMAP )
check_include_files ( stdint.hHAVE_STDINT_H )
check_include_files ( stdlib.hHAVE_STDLIB_H )
check_include_files ( strings.hHAVE_STRINGS_H )
check_include_files ( string.hHAVE_STRING_H )
check_include_files ( "sys/stat.h"HAVE_SYS_STAT_H )
check_include_files ( "sys/types.h"HAVE_SYS_TYPES_H )
check_include_files ( unistd.hHAVE_UNISTD_H )
set ( PACKAGE_BUGREPORT "expat-bugs@libexpat.org" )
set ( PACKAGE_NAME "expat" )
set ( PACKAGE_STRING "expat 2.0.0" )
set ( PACKAGE_TARNAME "expat" )
set ( PACKAGE_VERSION "2.0.0" )
check_include_files ( "stdlib.h;stdarg.h;string.h;float.h"STDC_HEADERS )
#WARNING: Following tests might NOT be the original test as found in original ./configure script!#TODO: Someone has to check it, pliz (I'm not an automake guru).# how to check WORDS_BIGENDIAN ? maybe:set ( WORDS_BIGENDIAN ${ENDIAN_TEST} )
# TODO:#/* Define to __FUNCTION__ or "" if `__func__' does not conform to ANSI C. */#cmakedefine __func__# TODO:#/* Define to empty if `const' does not conform to ANSI C. */#cmakedefine const#/* Define to `long' if <sys/types.h> does not define. */check_type_size ( "off_t"SIZEOF_OFF_T )	# check size of off_tif ( HAVE_SIZEOF_OFF_T )
set (HAVE_OFF_T 1)
else ()
set (HAVE_OFF_T 0)
set (off_t "long")
endif ()
#/* Define to `unsigned' if <sys/types.h> does not define. */check_type_size ( "size_t"SIZEOF_SIZE_T )
if ( HAVE_SIZEOF_SIZE_T )
set ( HAVE_SIZE_T 1 )
else ()
set ( HAVE_SIZE_T 0 )
set ( size_t "unsigned" )
endif ()
# all checks have been tested (all variables from expat_config.h.cmake were set)# so replace all #cmakedefine's in xpat_config.h.cmake with correct waluesconfigure_file ( ${CMAKE_CURRENT_SOURCE_DIR}/expat_config.h.cmake${CMAKE_CURRENT_BINARY_DIR}/expat_config.h ) # CONFIGURE_FILE operates on CONFIGURE_FILE(source_file destination_file) where# source_file - uses ${CMAKE_CURRENT_SOURCE_DIR} path - it is our source dir# destination_file - uses ${CMAKE_CURRENT_BINARY_DIR} path - we are doing out-of-source build, so this won't polute Expat sources message ( "Configure: Expat - done." )
# end of generating expat_config.h file:## Expat library# set include path to include lib directory and our build directory stored in ${CMAKE_CURRENT_BINARY_DIR}include_directories ( lib${CMAKE_CURRENT_BINARY_DIR}) # Expat library consist of these 3 filesset ( SRC_EXPATLIB lib/xmlparse.c lib/xmlrole.c lib/xmltok.c )
# add -DHAVE_EXPAT_CONFIG_H to compiler to tell we have our own expat_config.h fileadd_definitions ( -DHAVE_EXPAT_CONFIG_H )
# create the expat library using source files stored in ${SRC_EXPATLIB} and add .def file stored in ${DEF_FILE} if necessaryadd_library ( expatSHARED${SRC_EXPATLIB}lib/libexpat.def )
install_library ( expat )
install_header ( lib/expat.hlib/expat_external.h )
install_data ( COPYINGChangesREADME )
install_doc ( doc/ )
Note:
This tutorial only some aspects of translating libraries to CMake. It is a guide how to proceed and other libraries may require you to write more complex scripts, especially when you need to select files or compiler flags for platform/copiler specific tests. Please see other libraries providied by LuaDist for examples.
Alternatively you can submit an issue to the Repository Issues if you need help.
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Example: Building Libraries · LuaDist/Repository Wiki · GitHub
Skip to content

This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Example: Building Libraries
Jump to bottom

drahosp edited this page Mar 19, 2011
·
1 revision
Building Libraries
Building external dependencies and libraries is not trivial and requires either:
  • that the external dependency has a detailed documentation how to build it
  • you have a good understanding of make tools (autoconf, automake, etc.)
  • external dependencies use some other build tools e.g. SCons, Bakefiles etc. for building
At least moderate knowledge of CMake is recomended.
If you fulfill above criteria then all you have to do is:
  • define project name, usually the name of the module
  • include dist.cmake
    • this will set up all variables that contain installation paths
  • check platform/compiler specifics
  • generate a configuration header if needed (requires to write down a template file of the configuration header)
  • instruct CMAKE to search for external dependencies if needed

    • check if external dependencies were found
  • create the library
  • link library against other external dependencies
  • write commands for installing library and other files
Here is an commented example for the Expat library:
Write a configuration template file: expat_config.h.cmake
This file contains defines like this
/* Define to 1 if you have the `bcopy' function. */#cmakedefine HAVE_BCOPY ${HAVE_BCOPY}
and during configuration phase is evaluated to e.g.
#defineHAVE_BCOPY 1
depending whether compiler finds bcopy function.
Write CMakeLists.txt
The following example shows how configuration of headers can be implemented. On some libraries this is obsolete but for the purpose of example we will show a more complex situation.
# Copyright (C) 2007-2011 LuaDist.# Created by Peter Kapec# Redistribution and use of this file is allowed according to the terms of the MIT license.# For details see the COPYRIGHT file distributed with LuaDist.# Please note that the package source code is licensed under its own license.project ( libexpat C ) # projects name# CMake configuration:cmake_minimum_required ( VERSION2.6 )	# set minimum CMake version# Include dist.cmake, this defines install paths and some useful macrosinclude ( dist.cmake )
## Generating expat_config.h file:message ( "Configure: Expat - generating expat_config.h:" )
# include functions for checking stuffinclude (CheckIncludeFiles) # check for headersinclude (CheckFunctionExists)	# check for functionsinclude ( CheckSymbolExists ) # check for symbolsinclude ( TestBigEndian ) # check endiandnesinclude ( CheckTypeSize ) # check size of typestest_big_endian ( ENDIAN_TEST ) # check endiandness and set byte orderif ( ENDIAN_TEST )
set ( BYTEORDER 4321 ) else ()
set ( BYTEORDER 1234 )
endif ()
check_function_exists ( bcopyHAVE_BCOPY )	# check if bcopy existcheck_include_files ( dlfcn.hHAVE_DLFCN_H )	# check if dlfcn.h header existcheck_include_files ( fcntl.hHAVE_FCNTL_H )
check_function_exists ( getpagesizeHAVE_GETPAGESIZE )	# check if function getpagesize existcheck_include_files ( inttypes.hHAVE_INTTYPES_H )
check_function_exists ( memmoveHAVE_MEMMOVE )
check_include_files ( memory.hHAVE_MEMORY_H )
check_function_exists ( mmapHAVE_MMAP )
check_include_files ( stdint.hHAVE_STDINT_H )
check_include_files ( stdlib.hHAVE_STDLIB_H )
check_include_files ( strings.hHAVE_STRINGS_H )
check_include_files ( string.hHAVE_STRING_H )
check_include_files ( "sys/stat.h"HAVE_SYS_STAT_H )
check_include_files ( "sys/types.h"HAVE_SYS_TYPES_H )
check_include_files ( unistd.hHAVE_UNISTD_H )
set ( PACKAGE_BUGREPORT "expat-bugs@libexpat.org" )
set ( PACKAGE_NAME "expat" )
set ( PACKAGE_STRING "expat 2.0.0" )
set ( PACKAGE_TARNAME "expat" )
set ( PACKAGE_VERSION "2.0.0" )
check_include_files ( "stdlib.h;stdarg.h;string.h;float.h"STDC_HEADERS )
#WARNING: Following tests might NOT be the original test as found in original ./configure script!#TODO: Someone has to check it, pliz (I'm not an automake guru).# how to check WORDS_BIGENDIAN ? maybe:set ( WORDS_BIGENDIAN ${ENDIAN_TEST} )
# TODO:#/* Define to __FUNCTION__ or "" if `__func__' does not conform to ANSI C. */#cmakedefine __func__# TODO:#/* Define to empty if `const' does not conform to ANSI C. */#cmakedefine const#/* Define to `long' if <sys/types.h> does not define. */check_type_size ( "off_t"SIZEOF_OFF_T )	# check size of off_tif ( HAVE_SIZEOF_OFF_T )
set (HAVE_OFF_T 1)
else ()
set (HAVE_OFF_T 0)
set (off_t "long")
endif ()
#/* Define to `unsigned' if <sys/types.h> does not define. */check_type_size ( "size_t"SIZEOF_SIZE_T )
if ( HAVE_SIZEOF_SIZE_T )
set ( HAVE_SIZE_T 1 )
else ()
set ( HAVE_SIZE_T 0 )
set ( size_t "unsigned" )
endif ()
# all checks have been tested (all variables from expat_config.h.cmake were set)# so replace all #cmakedefine's in xpat_config.h.cmake with correct waluesconfigure_file ( ${CMAKE_CURRENT_SOURCE_DIR}/expat_config.h.cmake${CMAKE_CURRENT_BINARY_DIR}/expat_config.h ) # CONFIGURE_FILE operates on CONFIGURE_FILE(source_file destination_file) where# source_file - uses ${CMAKE_CURRENT_SOURCE_DIR} path - it is our source dir# destination_file - uses ${CMAKE_CURRENT_BINARY_DIR} path - we are doing out-of-source build, so this won't polute Expat sources message ( "Configure: Expat - done." )
# end of generating expat_config.h file:## Expat library# set include path to include lib directory and our build directory stored in ${CMAKE_CURRENT_BINARY_DIR}include_directories ( lib${CMAKE_CURRENT_BINARY_DIR}) # Expat library consist of these 3 filesset ( SRC_EXPATLIB lib/xmlparse.c lib/xmlrole.c lib/xmltok.c )
# add -DHAVE_EXPAT_CONFIG_H to compiler to tell we have our own expat_config.h fileadd_definitions ( -DHAVE_EXPAT_CONFIG_H )
# create the expat library using source files stored in ${SRC_EXPATLIB} and add .def file stored in ${DEF_FILE} if necessaryadd_library ( expatSHARED${SRC_EXPATLIB}lib/libexpat.def )
install_library ( expat )
install_header ( lib/expat.hlib/expat_external.h )
install_data ( COPYINGChangesREADME )
install_doc ( doc/ )
Note:
This tutorial only some aspects of translating libraries to CMake. It is a guide how to proceed and other libraries may require you to write more complex scripts, especially when you need to select files or compiler flags for platform/copiler specific tests. Please see other libraries providied by LuaDist for examples.
Alternatively you can submit an issue to the Repository Issues if you need help.
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Example: Building Libraries · LuaDist/Repository Wiki · GitHub
Skip to content

This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Example: Building Libraries
Jump to bottom

drahosp edited this page Mar 19, 2011
·
1 revision
Building Libraries
Building external dependencies and libraries is not trivial and requires either:
  • that the external dependency has a detailed documentation how to build it
  • you have a good understanding of make tools (autoconf, automake, etc.)
  • external dependencies use some other build tools e.g. SCons, Bakefiles etc. for building
At least moderate knowledge of CMake is recomended.
If you fulfill above criteria then all you have to do is:
  • define project name, usually the name of the module
  • include dist.cmake
    • this will set up all variables that contain installation paths
  • check platform/compiler specifics
  • generate a configuration header if needed (requires to write down a template file of the configuration header)
  • instruct CMAKE to search for external dependencies if needed

    • check if external dependencies were found
  • create the library
  • link library against other external dependencies
  • write commands for installing library and other files
Here is an commented example for the Expat library:
Write a configuration template file: expat_config.h.cmake
This file contains defines like this
/* Define to 1 if you have the `bcopy' function. */#cmakedefine HAVE_BCOPY ${HAVE_BCOPY}
and during configuration phase is evaluated to e.g.
#defineHAVE_BCOPY 1
depending whether compiler finds bcopy function.
Write CMakeLists.txt
The following example shows how configuration of headers can be implemented. On some libraries this is obsolete but for the purpose of example we will show a more complex situation.
# Copyright (C) 2007-2011 LuaDist.# Created by Peter Kapec# Redistribution and use of this file is allowed according to the terms of the MIT license.# For details see the COPYRIGHT file distributed with LuaDist.# Please note that the package source code is licensed under its own license.project ( libexpat C ) # projects name# CMake configuration:cmake_minimum_required ( VERSION2.6 )	# set minimum CMake version# Include dist.cmake, this defines install paths and some useful macrosinclude ( dist.cmake )
## Generating expat_config.h file:message ( "Configure: Expat - generating expat_config.h:" )
# include functions for checking stuffinclude (CheckIncludeFiles) # check for headersinclude (CheckFunctionExists)	# check for functionsinclude ( CheckSymbolExists ) # check for symbolsinclude ( TestBigEndian ) # check endiandnesinclude ( CheckTypeSize ) # check size of typestest_big_endian ( ENDIAN_TEST ) # check endiandness and set byte orderif ( ENDIAN_TEST )
set ( BYTEORDER 4321 ) else ()
set ( BYTEORDER 1234 )
endif ()
check_function_exists ( bcopyHAVE_BCOPY )	# check if bcopy existcheck_include_files ( dlfcn.hHAVE_DLFCN_H )	# check if dlfcn.h header existcheck_include_files ( fcntl.hHAVE_FCNTL_H )
check_function_exists ( getpagesizeHAVE_GETPAGESIZE )	# check if function getpagesize existcheck_include_files ( inttypes.hHAVE_INTTYPES_H )
check_function_exists ( memmoveHAVE_MEMMOVE )
check_include_files ( memory.hHAVE_MEMORY_H )
check_function_exists ( mmapHAVE_MMAP )
check_include_files ( stdint.hHAVE_STDINT_H )
check_include_files ( stdlib.hHAVE_STDLIB_H )
check_include_files ( strings.hHAVE_STRINGS_H )
check_include_files ( string.hHAVE_STRING_H )
check_include_files ( "sys/stat.h"HAVE_SYS_STAT_H )
check_include_files ( "sys/types.h"HAVE_SYS_TYPES_H )
check_include_files ( unistd.hHAVE_UNISTD_H )
set ( PACKAGE_BUGREPORT "expat-bugs@libexpat.org" )
set ( PACKAGE_NAME "expat" )
set ( PACKAGE_STRING "expat 2.0.0" )
set ( PACKAGE_TARNAME "expat" )
set ( PACKAGE_VERSION "2.0.0" )
check_include_files ( "stdlib.h;stdarg.h;string.h;float.h"STDC_HEADERS )
#WARNING: Following tests might NOT be the original test as found in original ./configure script!#TODO: Someone has to check it, pliz (I'm not an automake guru).# how to check WORDS_BIGENDIAN ? maybe:set ( WORDS_BIGENDIAN ${ENDIAN_TEST} )
# TODO:#/* Define to __FUNCTION__ or "" if `__func__' does not conform to ANSI C. */#cmakedefine __func__# TODO:#/* Define to empty if `const' does not conform to ANSI C. */#cmakedefine const#/* Define to `long' if <sys/types.h> does not define. */check_type_size ( "off_t"SIZEOF_OFF_T )	# check size of off_tif ( HAVE_SIZEOF_OFF_T )
set (HAVE_OFF_T 1)
else ()
set (HAVE_OFF_T 0)
set (off_t "long")
endif ()
#/* Define to `unsigned' if <sys/types.h> does not define. */check_type_size ( "size_t"SIZEOF_SIZE_T )
if ( HAVE_SIZEOF_SIZE_T )
set ( HAVE_SIZE_T 1 )
else ()
set ( HAVE_SIZE_T 0 )
set ( size_t "unsigned" )
endif ()
# all checks have been tested (all variables from expat_config.h.cmake were set)# so replace all #cmakedefine's in xpat_config.h.cmake with correct waluesconfigure_file ( ${CMAKE_CURRENT_SOURCE_DIR}/expat_config.h.cmake${CMAKE_CURRENT_BINARY_DIR}/expat_config.h ) # CONFIGURE_FILE operates on CONFIGURE_FILE(source_file destination_file) where# source_file - uses ${CMAKE_CURRENT_SOURCE_DIR} path - it is our source dir# destination_file - uses ${CMAKE_CURRENT_BINARY_DIR} path - we are doing out-of-source build, so this won't polute Expat sources message ( "Configure: Expat - done." )
# end of generating expat_config.h file:## Expat library# set include path to include lib directory and our build directory stored in ${CMAKE_CURRENT_BINARY_DIR}include_directories ( lib${CMAKE_CURRENT_BINARY_DIR}) # Expat library consist of these 3 filesset ( SRC_EXPATLIB lib/xmlparse.c lib/xmlrole.c lib/xmltok.c )
# add -DHAVE_EXPAT_CONFIG_H to compiler to tell we have our own expat_config.h fileadd_definitions ( -DHAVE_EXPAT_CONFIG_H )
# create the expat library using source files stored in ${SRC_EXPATLIB} and add .def file stored in ${DEF_FILE} if necessaryadd_library ( expatSHARED${SRC_EXPATLIB}lib/libexpat.def )
install_library ( expat )
install_header ( lib/expat.hlib/expat_external.h )
install_data ( COPYINGChangesREADME )
install_doc ( doc/ )
Note:
This tutorial only some aspects of translating libraries to CMake. It is a guide how to proceed and other libraries may require you to write more complex scripts, especially when you need to select files or compiler flags for platform/copiler specific tests. Please see other libraries providied by LuaDist for examples.
Alternatively you can submit an issue to the Repository Issues if you need help.
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Example: Building Libraries · LuaDist/Repository Wiki · GitHub
Skip to content

This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Example: Building Libraries
Jump to bottom

drahosp edited this page Mar 19, 2011
·
1 revision
Building Libraries
Building external dependencies and libraries is not trivial and requires either:
  • that the external dependency has a detailed documentation how to build it
  • you have a good understanding of make tools (autoconf, automake, etc.)
  • external dependencies use some other build tools e.g. SCons, Bakefiles etc. for building
At least moderate knowledge of CMake is recomended.
If you fulfill above criteria then all you have to do is:
  • define project name, usually the name of the module
  • include dist.cmake
    • this will set up all variables that contain installation paths
  • check platform/compiler specifics
  • generate a configuration header if needed (requires to write down a template file of the configuration header)
  • instruct CMAKE to search for external dependencies if needed

    • check if external dependencies were found
  • create the library
  • link library against other external dependencies
  • write commands for installing library and other files
Here is an commented example for the Expat library:
Write a configuration template file: expat_config.h.cmake
This file contains defines like this
/* Define to 1 if you have the `bcopy' function. */#cmakedefine HAVE_BCOPY ${HAVE_BCOPY}
and during configuration phase is evaluated to e.g.
#defineHAVE_BCOPY 1
depending whether compiler finds bcopy function.
Write CMakeLists.txt
The following example shows how configuration of headers can be implemented. On some libraries this is obsolete but for the purpose of example we will show a more complex situation.
# Copyright (C) 2007-2011 LuaDist.# Created by Peter Kapec# Redistribution and use of this file is allowed according to the terms of the MIT license.# For details see the COPYRIGHT file distributed with LuaDist.# Please note that the package source code is licensed under its own license.project ( libexpat C ) # projects name# CMake configuration:cmake_minimum_required ( VERSION2.6 )	# set minimum CMake version# Include dist.cmake, this defines install paths and some useful macrosinclude ( dist.cmake )
## Generating expat_config.h file:message ( "Configure: Expat - generating expat_config.h:" )
# include functions for checking stuffinclude (CheckIncludeFiles) # check for headersinclude (CheckFunctionExists)	# check for functionsinclude ( CheckSymbolExists ) # check for symbolsinclude ( TestBigEndian ) # check endiandnesinclude ( CheckTypeSize ) # check size of typestest_big_endian ( ENDIAN_TEST ) # check endiandness and set byte orderif ( ENDIAN_TEST )
set ( BYTEORDER 4321 ) else ()
set ( BYTEORDER 1234 )
endif ()
check_function_exists ( bcopyHAVE_BCOPY )	# check if bcopy existcheck_include_files ( dlfcn.hHAVE_DLFCN_H )	# check if dlfcn.h header existcheck_include_files ( fcntl.hHAVE_FCNTL_H )
check_function_exists ( getpagesizeHAVE_GETPAGESIZE )	# check if function getpagesize existcheck_include_files ( inttypes.hHAVE_INTTYPES_H )
check_function_exists ( memmoveHAVE_MEMMOVE )
check_include_files ( memory.hHAVE_MEMORY_H )
check_function_exists ( mmapHAVE_MMAP )
check_include_files ( stdint.hHAVE_STDINT_H )
check_include_files ( stdlib.hHAVE_STDLIB_H )
check_include_files ( strings.hHAVE_STRINGS_H )
check_include_files ( string.hHAVE_STRING_H )
check_include_files ( "sys/stat.h"HAVE_SYS_STAT_H )
check_include_files ( "sys/types.h"HAVE_SYS_TYPES_H )
check_include_files ( unistd.hHAVE_UNISTD_H )
set ( PACKAGE_BUGREPORT "expat-bugs@libexpat.org" )
set ( PACKAGE_NAME "expat" )
set ( PACKAGE_STRING "expat 2.0.0" )
set ( PACKAGE_TARNAME "expat" )
set ( PACKAGE_VERSION "2.0.0" )
check_include_files ( "stdlib.h;stdarg.h;string.h;float.h"STDC_HEADERS )
#WARNING: Following tests might NOT be the original test as found in original ./configure script!#TODO: Someone has to check it, pliz (I'm not an automake guru).# how to check WORDS_BIGENDIAN ? maybe:set ( WORDS_BIGENDIAN ${ENDIAN_TEST} )
# TODO:#/* Define to __FUNCTION__ or "" if `__func__' does not conform to ANSI C. */#cmakedefine __func__# TODO:#/* Define to empty if `const' does not conform to ANSI C. */#cmakedefine const#/* Define to `long' if <sys/types.h> does not define. */check_type_size ( "off_t"SIZEOF_OFF_T )	# check size of off_tif ( HAVE_SIZEOF_OFF_T )
set (HAVE_OFF_T 1)
else ()
set (HAVE_OFF_T 0)
set (off_t "long")
endif ()
#/* Define to `unsigned' if <sys/types.h> does not define. */check_type_size ( "size_t"SIZEOF_SIZE_T )
if ( HAVE_SIZEOF_SIZE_T )
set ( HAVE_SIZE_T 1 )
else ()
set ( HAVE_SIZE_T 0 )
set ( size_t "unsigned" )
endif ()
# all checks have been tested (all variables from expat_config.h.cmake were set)# so replace all #cmakedefine's in xpat_config.h.cmake with correct waluesconfigure_file ( ${CMAKE_CURRENT_SOURCE_DIR}/expat_config.h.cmake${CMAKE_CURRENT_BINARY_DIR}/expat_config.h ) # CONFIGURE_FILE operates on CONFIGURE_FILE(source_file destination_file) where# source_file - uses ${CMAKE_CURRENT_SOURCE_DIR} path - it is our source dir# destination_file - uses ${CMAKE_CURRENT_BINARY_DIR} path - we are doing out-of-source build, so this won't polute Expat sources message ( "Configure: Expat - done." )
# end of generating expat_config.h file:## Expat library# set include path to include lib directory and our build directory stored in ${CMAKE_CURRENT_BINARY_DIR}include_directories ( lib${CMAKE_CURRENT_BINARY_DIR}) # Expat library consist of these 3 filesset ( SRC_EXPATLIB lib/xmlparse.c lib/xmlrole.c lib/xmltok.c )
# add -DHAVE_EXPAT_CONFIG_H to compiler to tell we have our own expat_config.h fileadd_definitions ( -DHAVE_EXPAT_CONFIG_H )
# create the expat library using source files stored in ${SRC_EXPATLIB} and add .def file stored in ${DEF_FILE} if necessaryadd_library ( expatSHARED${SRC_EXPATLIB}lib/libexpat.def )
install_library ( expat )
install_header ( lib/expat.hlib/expat_external.h )
install_data ( COPYINGChangesREADME )
install_doc ( doc/ )
Note:
This tutorial only some aspects of translating libraries to CMake. It is a guide how to proceed and other libraries may require you to write more complex scripts, especially when you need to select files or compiler flags for platform/copiler specific tests. Please see other libraries providied by LuaDist for examples.
Alternatively you can submit an issue to the Repository Issues if you need help.
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Example: Building Libraries · LuaDist/Repository Wiki · GitHub
Skip to content

This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Example: Building Libraries
Jump to bottom

drahosp edited this page Mar 19, 2011
·
1 revision
Building Libraries
Building external dependencies and libraries is not trivial and requires either:
  • that the external dependency has a detailed documentation how to build it
  • you have a good understanding of make tools (autoconf, automake, etc.)
  • external dependencies use some other build tools e.g. SCons, Bakefiles etc. for building
At least moderate knowledge of CMake is recomended.
If you fulfill above criteria then all you have to do is:
  • define project name, usually the name of the module
  • include dist.cmake
    • this will set up all variables that contain installation paths
  • check platform/compiler specifics
  • generate a configuration header if needed (requires to write down a template file of the configuration header)
  • instruct CMAKE to search for external dependencies if needed

    • check if external dependencies were found
  • create the library
  • link library against other external dependencies
  • write commands for installing library and other files
Here is an commented example for the Expat library:
Write a configuration template file: expat_config.h.cmake
This file contains defines like this
/* Define to 1 if you have the `bcopy' function. */#cmakedefine HAVE_BCOPY ${HAVE_BCOPY}
and during configuration phase is evaluated to e.g.
#defineHAVE_BCOPY 1
depending whether compiler finds bcopy function.
Write CMakeLists.txt
The following example shows how configuration of headers can be implemented. On some libraries this is obsolete but for the purpose of example we will show a more complex situation.
# Copyright (C) 2007-2011 LuaDist.# Created by Peter Kapec# Redistribution and use of this file is allowed according to the terms of the MIT license.# For details see the COPYRIGHT file distributed with LuaDist.# Please note that the package source code is licensed under its own license.project ( libexpat C ) # projects name# CMake configuration:cmake_minimum_required ( VERSION2.6 )	# set minimum CMake version# Include dist.cmake, this defines install paths and some useful macrosinclude ( dist.cmake )
## Generating expat_config.h file:message ( "Configure: Expat - generating expat_config.h:" )
# include functions for checking stuffinclude (CheckIncludeFiles) # check for headersinclude (CheckFunctionExists)	# check for functionsinclude ( CheckSymbolExists ) # check for symbolsinclude ( TestBigEndian ) # check endiandnesinclude ( CheckTypeSize ) # check size of typestest_big_endian ( ENDIAN_TEST ) # check endiandness and set byte orderif ( ENDIAN_TEST )
set ( BYTEORDER 4321 ) else ()
set ( BYTEORDER 1234 )
endif ()
check_function_exists ( bcopyHAVE_BCOPY )	# check if bcopy existcheck_include_files ( dlfcn.hHAVE_DLFCN_H )	# check if dlfcn.h header existcheck_include_files ( fcntl.hHAVE_FCNTL_H )
check_function_exists ( getpagesizeHAVE_GETPAGESIZE )	# check if function getpagesize existcheck_include_files ( inttypes.hHAVE_INTTYPES_H )
check_function_exists ( memmoveHAVE_MEMMOVE )
check_include_files ( memory.hHAVE_MEMORY_H )
check_function_exists ( mmapHAVE_MMAP )
check_include_files ( stdint.hHAVE_STDINT_H )
check_include_files ( stdlib.hHAVE_STDLIB_H )
check_include_files ( strings.hHAVE_STRINGS_H )
check_include_files ( string.hHAVE_STRING_H )
check_include_files ( "sys/stat.h"HAVE_SYS_STAT_H )
check_include_files ( "sys/types.h"HAVE_SYS_TYPES_H )
check_include_files ( unistd.hHAVE_UNISTD_H )
set ( PACKAGE_BUGREPORT "expat-bugs@libexpat.org" )
set ( PACKAGE_NAME "expat" )
set ( PACKAGE_STRING "expat 2.0.0" )
set ( PACKAGE_TARNAME "expat" )
set ( PACKAGE_VERSION "2.0.0" )
check_include_files ( "stdlib.h;stdarg.h;string.h;float.h"STDC_HEADERS )
#WARNING: Following tests might NOT be the original test as found in original ./configure script!#TODO: Someone has to check it, pliz (I'm not an automake guru).# how to check WORDS_BIGENDIAN ? maybe:set ( WORDS_BIGENDIAN ${ENDIAN_TEST} )
# TODO:#/* Define to __FUNCTION__ or "" if `__func__' does not conform to ANSI C. */#cmakedefine __func__# TODO:#/* Define to empty if `const' does not conform to ANSI C. */#cmakedefine const#/* Define to `long' if <sys/types.h> does not define. */check_type_size ( "off_t"SIZEOF_OFF_T )	# check size of off_tif ( HAVE_SIZEOF_OFF_T )
set (HAVE_OFF_T 1)
else ()
set (HAVE_OFF_T 0)
set (off_t "long")
endif ()
#/* Define to `unsigned' if <sys/types.h> does not define. */check_type_size ( "size_t"SIZEOF_SIZE_T )
if ( HAVE_SIZEOF_SIZE_T )
set ( HAVE_SIZE_T 1 )
else ()
set ( HAVE_SIZE_T 0 )
set ( size_t "unsigned" )
endif ()
# all checks have been tested (all variables from expat_config.h.cmake were set)# so replace all #cmakedefine's in xpat_config.h.cmake with correct waluesconfigure_file ( ${CMAKE_CURRENT_SOURCE_DIR}/expat_config.h.cmake${CMAKE_CURRENT_BINARY_DIR}/expat_config.h ) # CONFIGURE_FILE operates on CONFIGURE_FILE(source_file destination_file) where# source_file - uses ${CMAKE_CURRENT_SOURCE_DIR} path - it is our source dir# destination_file - uses ${CMAKE_CURRENT_BINARY_DIR} path - we are doing out-of-source build, so this won't polute Expat sources message ( "Configure: Expat - done." )
# end of generating expat_config.h file:## Expat library# set include path to include lib directory and our build directory stored in ${CMAKE_CURRENT_BINARY_DIR}include_directories ( lib${CMAKE_CURRENT_BINARY_DIR}) # Expat library consist of these 3 filesset ( SRC_EXPATLIB lib/xmlparse.c lib/xmlrole.c lib/xmltok.c )
# add -DHAVE_EXPAT_CONFIG_H to compiler to tell we have our own expat_config.h fileadd_definitions ( -DHAVE_EXPAT_CONFIG_H )
# create the expat library using source files stored in ${SRC_EXPATLIB} and add .def file stored in ${DEF_FILE} if necessaryadd_library ( expatSHARED${SRC_EXPATLIB}lib/libexpat.def )
install_library ( expat )
install_header ( lib/expat.hlib/expat_external.h )
install_data ( COPYINGChangesREADME )
install_doc ( doc/ )
Note:
This tutorial only some aspects of translating libraries to CMake. It is a guide how to proceed and other libraries may require you to write more complex scripts, especially when you need to select files or compiler flags for platform/copiler specific tests. Please see other libraries providied by LuaDist for examples.
Alternatively you can submit an issue to the Repository Issues if you need help.
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Example: Building Libraries · LuaDist/Repository Wiki · GitHub
Skip to content

This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Example: Building Libraries
Jump to bottom

drahosp edited this page Mar 19, 2011
·
1 revision
Building Libraries
Building external dependencies and libraries is not trivial and requires either:
  • that the external dependency has a detailed documentation how to build it
  • you have a good understanding of make tools (autoconf, automake, etc.)
  • external dependencies use some other build tools e.g. SCons, Bakefiles etc. for building
At least moderate knowledge of CMake is recomended.
If you fulfill above criteria then all you have to do is:
  • define project name, usually the name of the module
  • include dist.cmake
    • this will set up all variables that contain installation paths
  • check platform/compiler specifics
  • generate a configuration header if needed (requires to write down a template file of the configuration header)
  • instruct CMAKE to search for external dependencies if needed

    • check if external dependencies were found
  • create the library
  • link library against other external dependencies
  • write commands for installing library and other files
Here is an commented example for the Expat library:
Write a configuration template file: expat_config.h.cmake
This file contains defines like this
/* Define to 1 if you have the `bcopy' function. */#cmakedefine HAVE_BCOPY ${HAVE_BCOPY}
and during configuration phase is evaluated to e.g.
#defineHAVE_BCOPY 1
depending whether compiler finds bcopy function.
Write CMakeLists.txt
The following example shows how configuration of headers can be implemented. On some libraries this is obsolete but for the purpose of example we will show a more complex situation.
# Copyright (C) 2007-2011 LuaDist.# Created by Peter Kapec# Redistribution and use of this file is allowed according to the terms of the MIT license.# For details see the COPYRIGHT file distributed with LuaDist.# Please note that the package source code is licensed under its own license.project ( libexpat C ) # projects name# CMake configuration:cmake_minimum_required ( VERSION2.6 )	# set minimum CMake version# Include dist.cmake, this defines install paths and some useful macrosinclude ( dist.cmake )
## Generating expat_config.h file:message ( "Configure: Expat - generating expat_config.h:" )
# include functions for checking stuffinclude (CheckIncludeFiles) # check for headersinclude (CheckFunctionExists)	# check for functionsinclude ( CheckSymbolExists ) # check for symbolsinclude ( TestBigEndian ) # check endiandnesinclude ( CheckTypeSize ) # check size of typestest_big_endian ( ENDIAN_TEST ) # check endiandness and set byte orderif ( ENDIAN_TEST )
set ( BYTEORDER 4321 ) else ()
set ( BYTEORDER 1234 )
endif ()
check_function_exists ( bcopyHAVE_BCOPY )	# check if bcopy existcheck_include_files ( dlfcn.hHAVE_DLFCN_H )	# check if dlfcn.h header existcheck_include_files ( fcntl.hHAVE_FCNTL_H )
check_function_exists ( getpagesizeHAVE_GETPAGESIZE )	# check if function getpagesize existcheck_include_files ( inttypes.hHAVE_INTTYPES_H )
check_function_exists ( memmoveHAVE_MEMMOVE )
check_include_files ( memory.hHAVE_MEMORY_H )
check_function_exists ( mmapHAVE_MMAP )
check_include_files ( stdint.hHAVE_STDINT_H )
check_include_files ( stdlib.hHAVE_STDLIB_H )
check_include_files ( strings.hHAVE_STRINGS_H )
check_include_files ( string.hHAVE_STRING_H )
check_include_files ( "sys/stat.h"HAVE_SYS_STAT_H )
check_include_files ( "sys/types.h"HAVE_SYS_TYPES_H )
check_include_files ( unistd.hHAVE_UNISTD_H )
set ( PACKAGE_BUGREPORT "expat-bugs@libexpat.org" )
set ( PACKAGE_NAME "expat" )
set ( PACKAGE_STRING "expat 2.0.0" )
set ( PACKAGE_TARNAME "expat" )
set ( PACKAGE_VERSION "2.0.0" )
check_include_files ( "stdlib.h;stdarg.h;string.h;float.h"STDC_HEADERS )
#WARNING: Following tests might NOT be the original test as found in original ./configure script!#TODO: Someone has to check it, pliz (I'm not an automake guru).# how to check WORDS_BIGENDIAN ? maybe:set ( WORDS_BIGENDIAN ${ENDIAN_TEST} )
# TODO:#/* Define to __FUNCTION__ or "" if `__func__' does not conform to ANSI C. */#cmakedefine __func__# TODO:#/* Define to empty if `const' does not conform to ANSI C. */#cmakedefine const#/* Define to `long' if <sys/types.h> does not define. */check_type_size ( "off_t"SIZEOF_OFF_T )	# check size of off_tif ( HAVE_SIZEOF_OFF_T )
set (HAVE_OFF_T 1)
else ()
set (HAVE_OFF_T 0)
set (off_t "long")
endif ()
#/* Define to `unsigned' if <sys/types.h> does not define. */check_type_size ( "size_t"SIZEOF_SIZE_T )
if ( HAVE_SIZEOF_SIZE_T )
set ( HAVE_SIZE_T 1 )
else ()
set ( HAVE_SIZE_T 0 )
set ( size_t "unsigned" )
endif ()
# all checks have been tested (all variables from expat_config.h.cmake were set)# so replace all #cmakedefine's in xpat_config.h.cmake with correct waluesconfigure_file ( ${CMAKE_CURRENT_SOURCE_DIR}/expat_config.h.cmake${CMAKE_CURRENT_BINARY_DIR}/expat_config.h ) # CONFIGURE_FILE operates on CONFIGURE_FILE(source_file destination_file) where# source_file - uses ${CMAKE_CURRENT_SOURCE_DIR} path - it is our source dir# destination_file - uses ${CMAKE_CURRENT_BINARY_DIR} path - we are doing out-of-source build, so this won't polute Expat sources message ( "Configure: Expat - done." )
# end of generating expat_config.h file:## Expat library# set include path to include lib directory and our build directory stored in ${CMAKE_CURRENT_BINARY_DIR}include_directories ( lib${CMAKE_CURRENT_BINARY_DIR}) # Expat library consist of these 3 filesset ( SRC_EXPATLIB lib/xmlparse.c lib/xmlrole.c lib/xmltok.c )
# add -DHAVE_EXPAT_CONFIG_H to compiler to tell we have our own expat_config.h fileadd_definitions ( -DHAVE_EXPAT_CONFIG_H )
# create the expat library using source files stored in ${SRC_EXPATLIB} and add .def file stored in ${DEF_FILE} if necessaryadd_library ( expatSHARED${SRC_EXPATLIB}lib/libexpat.def )
install_library ( expat )
install_header ( lib/expat.hlib/expat_external.h )
install_data ( COPYINGChangesREADME )
install_doc ( doc/ )
Note:
This tutorial only some aspects of translating libraries to CMake. It is a guide how to proceed and other libraries may require you to write more complex scripts, especially when you need to select files or compiler flags for platform/copiler specific tests. Please see other libraries providied by LuaDist for examples.
Alternatively you can submit an issue to the Repository Issues if you need help.
Clone this wiki locally

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Example: Building Libraries · LuaDist/Repository Wiki · GitHub
Skip to content

This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Example: Building Libraries
Jump to bottom

drahosp edited this page Mar 19, 2011
·
1 revision
Building Libraries
Building external dependencies and libraries is not trivial and requires either:
  • that the external dependency has a detailed documentation how to build it
  • you have a good understanding of make tools (autoconf, automake, etc.)
  • external dependencies use some other build tools e.g. SCons, Bakefiles etc. for building
At least moderate knowledge of CMake is recomended.
If you fulfill above criteria then all you have to do is:
  • define project name, usually the name of the module
  • include dist.cmake
    • this will set up all variables that contain installation paths
  • check platform/compiler specifics
  • generate a configuration header if needed (requires to write down a template file of the configuration header)
  • instruct CMAKE to search for external dependencies if needed

    • check if external dependencies were found
  • create the library
  • link library against other external dependencies
  • write commands for installing library and other files
Here is an commented example for the Expat library:
Write a configuration template file: expat_config.h.cmake
This file contains defines like this
/* Define to 1 if you have the `bcopy' function. */#cmakedefine HAVE_BCOPY ${HAVE_BCOPY}
and during configuration phase is evaluated to e.g.
#defineHAVE_BCOPY 1
depending whether compiler finds bcopy function.
Write CMakeLists.txt
The following example shows how configuration of headers can be implemented. On some libraries this is obsolete but for the purpose of example we will show a more complex situation.
# Copyright (C) 2007-2011 LuaDist.# Created by Peter Kapec# Redistribution and use of this file is allowed according to the terms of the MIT license.# For details see the COPYRIGHT file distributed with LuaDist.# Please note that the package source code is licensed under its own license.project ( libexpat C ) # projects name# CMake configuration:cmake_minimum_required ( VERSION2.6 )	# set minimum CMake version# Include dist.cmake, this defines install paths and some useful macrosinclude ( dist.cmake )
## Generating expat_config.h file:message ( "Configure: Expat - generating expat_config.h:" )
# include functions for checking stuffinclude (CheckIncludeFiles) # check for headersinclude (CheckFunctionExists)	# check for functionsinclude ( CheckSymbolExists ) # check for symbolsinclude ( TestBigEndian ) # check endiandnesinclude ( CheckTypeSize ) # check size of typestest_big_endian ( ENDIAN_TEST ) # check endiandness and set byte orderif ( ENDIAN_TEST )
set ( BYTEORDER 4321 ) else ()
set ( BYTEORDER 1234 )
endif ()
check_function_exists ( bcopyHAVE_BCOPY )	# check if bcopy existcheck_include_files ( dlfcn.hHAVE_DLFCN_H )	# check if dlfcn.h header existcheck_include_files ( fcntl.hHAVE_FCNTL_H )
check_function_exists ( getpagesizeHAVE_GETPAGESIZE )	# check if function getpagesize existcheck_include_files ( inttypes.hHAVE_INTTYPES_H )
check_function_exists ( memmoveHAVE_MEMMOVE )
check_include_files ( memory.hHAVE_MEMORY_H )
check_function_exists ( mmapHAVE_MMAP )
check_include_files ( stdint.hHAVE_STDINT_H )
check_include_files ( stdlib.hHAVE_STDLIB_H )
check_include_files ( strings.hHAVE_STRINGS_H )
check_include_files ( string.hHAVE_STRING_H )
check_include_files ( "sys/stat.h"HAVE_SYS_STAT_H )
check_include_files ( "sys/types.h"HAVE_SYS_TYPES_H )
check_include_files ( unistd.hHAVE_UNISTD_H )
set ( PACKAGE_BUGREPORT "expat-bugs@libexpat.org" )
set ( PACKAGE_NAME "expat" )
set ( PACKAGE_STRING "expat 2.0.0" )
set ( PACKAGE_TARNAME "expat" )
set ( PACKAGE_VERSION "2.0.0" )
check_include_files ( "stdlib.h;stdarg.h;string.h;float.h"STDC_HEADERS )
#WARNING: Following tests might NOT be the original test as found in original ./configure script!#TODO: Someone has to check it, pliz (I'm not an automake guru).# how to check WORDS_BIGENDIAN ? maybe:set ( WORDS_BIGENDIAN ${ENDIAN_TEST} )
# TODO:#/* Define to __FUNCTION__ or "" if `__func__' does not conform to ANSI C. */#cmakedefine __func__# TODO:#/* Define to empty if `const' does not conform to ANSI C. */#cmakedefine const#/* Define to `long' if <sys/types.h> does not define. */check_type_size ( "off_t"SIZEOF_OFF_T )	# check size of off_tif ( HAVE_SIZEOF_OFF_T )
set (HAVE_OFF_T 1)
else ()
set (HAVE_OFF_T 0)
set (off_t "long")
endif ()
#/* Define to `unsigned' if <sys/types.h> does not define. */check_type_size ( "size_t"SIZEOF_SIZE_T )
if ( HAVE_SIZEOF_SIZE_T )
set ( HAVE_SIZE_T 1 )
else ()
set ( HAVE_SIZE_T 0 )
set ( size_t "unsigned" )
endif ()
# all checks have been tested (all variables from expat_config.h.cmake were set)# so replace all #cmakedefine's in xpat_config.h.cmake with correct waluesconfigure_file ( ${CMAKE_CURRENT_SOURCE_DIR}/expat_config.h.cmake${CMAKE_CURRENT_BINARY_DIR}/expat_config.h ) # CONFIGURE_FILE operates on CONFIGURE_FILE(source_file destination_file) where# source_file - uses ${CMAKE_CURRENT_SOURCE_DIR} path - it is our source dir# destination_file - uses ${CMAKE_CURRENT_BINARY_DIR} path - we are doing out-of-source build, so this won't polute Expat sources message ( "Configure: Expat - done." )
# end of generating expat_config.h file:## Expat library# set include path to include lib directory and our build directory stored in ${CMAKE_CURRENT_BINARY_DIR}include_directories ( lib${CMAKE_CURRENT_BINARY_DIR}) # Expat library consist of these 3 filesset ( SRC_EXPATLIB lib/xmlparse.c lib/xmlrole.c lib/xmltok.c )
# add -DHAVE_EXPAT_CONFIG_H to compiler to tell we have our own expat_config.h fileadd_definitions ( -DHAVE_EXPAT_CONFIG_H )
# create the expat library using source files stored in ${SRC_EXPATLIB} and add .def file stored in ${DEF_FILE} if necessaryadd_library ( expatSHARED${SRC_EXPATLIB}lib/libexpat.def )
install_library ( expat )
install_header ( lib/expat.hlib/expat_external.h )
install_data ( COPYINGChangesREADME )
install_doc ( doc/ )
Note:
This tutorial only some aspects of translating libraries to CMake. It is a guide how to proceed and other libraries may require you to write more complex scripts, especially when you need to select files or compiler flags for platform/copiler specific tests. Please see other libraries providied by LuaDist for examples.
Alternatively you can submit an issue to the Repository Issues if you need help.
Clone this wiki locally