commit 5d108d7f95a5ea4002de5db01fa46add5955c0fc Author: Sameer Rahmani Date: Sat Aug 6 22:15:00 2022 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6f5abf3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,33 @@ +/target +*~ +/build +CMakeLists.txt.user +CMakeCache.txt +CMakeFiles +CMakeScripts +Testing +Makefile +cmake_install.cmake +install_manifest.txt +compile_commands.json +CTestTestfile.cmake +_deps +.ccls-cache +.clangd +.cache/ +.vscode/ +CMakeDoxyfile.in +CMakeDoxygenDefaults.cmake +DartConfiguration.tcl +bin/serenec_CXX_cotire.cmake +/config.h + +docs/Doxyfile.docs +.ccache/ +docs/spec.tex +docs/spec.pdf +.tmp +.env +.tex +.pdf +docs/overall_picture.png diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..2b05f97 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,152 @@ +# Feynman -- Wayland compositor for GNU Emacs +# +# Copyright (c) 2022 Sameer Rahmani +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 2. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +cmake_minimum_required(VERSION 3.19) + + +# Project name and a few useful settings. Other commands can pick up the results +project(Feynman + VERSION 0.0.0 + DESCRIPTION "Wayland compositor for GNU Emacs" + LANGUAGES C) + +# Clangd command file +set(CMAKE_EXPORT_COMPILE_COMMANDS 1) + +# Policies ========================== +cmake_policy(SET CMP0116 OLD) + +# User Options ====================== +option(FEYNMAN_ENABLE_BUILDID "Enable build id." OFF) +option(FEYNMAN_ENABLE_TIDY "Enable clang tidy check" OFF) +option(FEYNMAN_DISABLE_CCACHE "Disable automatic ccache integration" OFF) + +set(FEYNMAN_EMACS_DIR "" CACHE PATH "PATH to the Emacs build directory") + +# Only do these if this is the main project, and not if it is included through add_subdirectory +if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) + ## Settings ======================= + + set(CMAKE_C_STANDARD 11) + set(CMAKE_C_STANDARD_REQUIRED True) + + # Setup the source locations + set(INCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/) + #configure_file(${INCLUDE_DIR}/config.h.in src/config.h) + + if(FEYNMAN_ENABLE_TIDY) + find_program(CLANG_TIDY_PATH NAMES clang-tidy REQUIRED) + endif() + + find_program(iwyu NAMES include-what-you-use iwyu REQUIRED) + set(iwyu_path ${iwyu}) + + find_package(PkgConfig REQUIRED) + + set(MemoryCheckCommand "valgrind") + + # Let's nicely support folders in IDEs + set_property(GLOBAL PROPERTY USE_FOLDERS ON) + + + # Setup the basic compiler flags + add_compile_options( + -Wall + -Wextra + -Werror + -fno-rtti + + # Dedicate a section to each function, so the linker + # can do a better job on dead code elimination + -ffunction-sections + -fdata-sections + + $<$:-g3> + $<$:-O1> + $<$:-ggdb> + # For the sake of debugging + $<$:-fno-inline> + # To make the local ccache happy + $<$:-fdebug-prefix-map=${PROJECT_SOURCE_DIR}=.> + + # No tail call elimination on Debug to let asan provide + # better stacktrackes + $<$:-fno-optimize-sibling-calls> + $<$:-fno-omit-frame-pointer> + $<$:-fomit-frame-pointer> + + $<$:-O3> + $<$:-fmerge-all-constants> + ) + + add_link_options( + # We enforce the lld linker + -fuse-ld=lld + -Wl,-gc-sections + $<$:-s> + # Do not link against shared libraries + #--static + ) + + if(FEYNMAN_ENABLE_BUILDID) + add_link_options(-Wl,--build-id) + endif() + + include(GNUInstallDirs) + Include(FetchContent) + + # CCache support ============================== + if(FEYNMAN_DISABLE_CCACHE) + message(STATUS "CCache support is disabled") + else() + + find_program(CCACHE_PROGRAM ccache) + + if(CCACHE_PROGRAM) + message(STATUS "Found CCache") + set(FEYNMAN_CCACHE_MAXSIZE "" CACHE STRING "Size of ccache") + set(FEYNMAN_CCACHE_DIR "" CACHE STRING "Directory to keep ccached data") + set(FEYNMAN_CCACHE_PARAMS "CCACHE_CPP2=yes CCACHE_HASHDIR=yes" + CACHE STRING "Parameters to pass through to ccache") + + set(CCACHE_PROGRAM "${FEYNMAN_CCACHE_PARAMS} ${CCACHE_PROGRAM}") + + if (FEYNMAN_CCACHE_MAXSIZE) + set(CCACHE_PROGRAM "CCACHE_MAXSIZE=${FEYNMAN_CCACHE_MAXSIZE} ${CCACHE_PROGRAM}") + endif() + if (FEYNMAN_CCACHE_DIR) + set(CCACHE_PROGRAM "CCACHE_DIR=${FEYNMAN_CCACHE_DIR} ${CCACHE_PROGRAM}") + endif() + message(STATUS "Using CCACHE: ${CCACHE_PROGRAM}") + set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE_PROGRAM}) + else() + message(FATAL_ERROR "Unable to find the program ccache. Set FEYNMAN_DISABLE_CCACHE to ON") + endif() + endif() + + # Feynman Setup =================================== + + include_directories(SYSTEM ${PROJECT_BINARY_DIR}/src) + include_directories(SYSTEM ${FEYNMAN_EMACS_DIR}/inculde) + + # Hide all the symbols by default + if(NOT DEFINED CMAKE_CXX_VISIBILITY_PRESET AND + NOT DEFINED CMAKE_VISIBILITY_INLINES_HIDDEN) + set(CMAKE_C_VISIBILITY_PRESET hidden) + set(CMAKE_VISIBILITY_INLINES_HIDDEN YES) + endif() + + add_subdirectory(src) +endif() diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/builder b/builder new file mode 100755 index 0000000..5c29f23 --- /dev/null +++ b/builder @@ -0,0 +1,229 @@ +#! /bin/bash +# Feynman -- Wayland compositor for GNU Emacs +# +# Copyright (c) 2022 Sameer Rahmani +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 2. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# ----------------------------------------------------------------------------- +# Commentary +# ----------------------------------------------------------------------------- +# This is the builder script for the Feynman project. It makes it easier to +# interact with the CMake build scripts. +# +# In order to define a subcommand all you need to do is to define a function +# with the following syntax: +# +# function subcommand-name() { ## DESCRIPTION +# .. subcommand body .. +# } +# +# Make sure to provid one line of DESCRIPTION for the subcommand and use two "#" +# characters to start the description following by a space. Otherwise, your +# subcommand won't be registered +# +## Verbos Mode +# In order to turn on the verbose mode for your build just invoke the builder script +# like: +# +# $ VERBOSE=ON ./builder build/ +# + +set -e + +# ----------------------------------------------------------------------------- +# Vars & Config +# ----------------------------------------------------------------------------- + +command=$1 +VERSION="0.1.0" + +EMACS_DEV=${EMACS_DEV:-$HOME/builds/emacs/2022-08-05/} + +CC=$(which clang) +CXX=$(which clang++) + +export CC +export CXX + +# TODO: Add sloppiness to the cmake list file as well +export CCACHE_SLOPPINESS="pch_defines,time_macros" + +export ASAN_OPTIONS=check_initialization_order=1 +LSAN_OPTIONS=suppressions=$(pwd)/.ignore_sanitize +export LSAN_OPTIONS +export LDFLAGS="-fuse-ld=lld" + +# The `builder` script is supposed to be run from the +# root of the source tree +ROOT_DIR=$(pwd) +BUILD_DIR=$ROOT_DIR/build +ME=$(cd "$(dirname "$0")/." >/dev/null 2>&1 ; pwd -P) + +CMAKEARGS_DEBUG=("-DCMAKE_BUILD_TYPE=Debug") +CMAKEARGS=("-DCMAKE_EXPORT_COMPILE_COMMANDS=ON" + "-DFEYNMAN_EMACS_DIR=$EMACS_DEV" + "-DFEYNMAN_CCACHE_DIR=$HOME/.ccache") + +# shellcheck source=./scripts/utils.sh +source "$ME/scripts/utils.sh" + + +# ----------------------------------------------------------------------------- +# Helper functions +# ----------------------------------------------------------------------------- + +function pushed_build() { + mkdir -p "$BUILD_DIR" + pushd "$BUILD_DIR" > /dev/null || return +} + + +function popd_build() { + popd > /dev/null || return +} + + +function build-gen() { + pushed_build + info "Running: " + info "cmake -G Ninja ${CMAKEARGS[*]} ${CMAKEARGS[*]}" "\"$*\" \"$ROOT_DIR\"" + cmake -G Ninja "${CMAKEARGS[@]}" "${CMAKEARGS_DEBUG[@]}" "$*" "$ROOT_DIR" + popd_build +} + +# ----------------------------------------------------------------------------- +# Subcomaands +# ----------------------------------------------------------------------------- +function compile() { ## Compiles the project using the generated build scripts + pushed_build + cmake --build . + popd_build +} + +function build() { ## Builds the project by regenerating the build scripts + local cpus + + clean + build-gen "$@" + pushed_build + + cpus=$(nproc) + cmake --build . -j "$cpus" + + popd_build +} + + +function build-tidy() { ## Builds the project using clang-tidy (It takes longer than usual) + build "-DFEYNMAN_ENABLE_TIDY=ON" "${@:2}" +} + +function build-release() { ## Builds the project in "Release" mode + clean + pushed_build + cmake -G Ninja -DCMAKE_BUILD_TYPE=Release "${CMAKEARGS[@]}" "$ROOT_DIR" + cmake --build . --config Release + popd_build +} + +function clean() { ## Cleans up the source dir and removes the build + rm -rf "$BUILD_DIR" + rm -rf "$(find . -iname '*~')" +} + +function run() { ## Runs Emacs and loads feynman + "$EMACS_DEV/bin/emacs" -Q --eval "(setq feynman_path \"$ME/build/src/libfeynman.so\")" --load "$ME/lisp/test.el" "$@" +} + + +function memcheck-feynman() { ## Runs `valgrind` to check `feynman` birany + export ASAN_FLAG="" + build + pushed_build + valgrind --tool=memcheck --leak-check=yes --trace-children=yes "$BUILD_DIR"/bin/feynman "$@" + popd_build +} + +function tests() { ## Runs all the test cases + if [[ "$1" == "all" || "$1" == "" ]]; then + info "Run the entire test suit" + for proj in "${PROJECTS[@]}"; do + local test_file="$BUILD_DIR/$proj/tests/${proj}Tests" + + if [[ -f "$test_file" ]]; then + eval "$test_file ${*:2}" + fi + done + else + eval "$BUILD_DIR/$1/tests/$1Tests ${*:2}" + fi +} + +function build-tests() { ## Generates and build the project including the test cases + clean + pushed_build + cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -DFEYNMAN_BUILD_TESTING=ON "$ROOT_DIR" + cmake --build . + popd_build +} + + +function setup() { ## Setup the working directory and make it ready for development + if command -v python3 >/dev/null 2>&1; then + pip install pre-commit + pre-commit install + else + error "Python is required to setup pre-commit" + fi +} + + +function scan-build() { ## Runs the `scan-build` utility to analyze the build process + clean + build-gen + pushed_build + # The scan-build utility scans the build for bugs checkout the man page + scan-build --force-analyze-debug-code --use-analyzer="$CC" cmake --build . + popd_build +} + +function help() { ## Print out this help message + echo "Commands:" + grep -E '^function [a-zA-Z0-9_-]+\(\) \{ ## .*$$' "$0" | \ + sort | \ + sed 's/^function \([a-zA-Z0-9_-]*\)() { ## \(.*\)/\1:\2/' | \ + awk 'BEGIN {FS=":"}; {printf "\033[36m%-30s\033[0m %s\n", $1, $2}' +} + +# ----------------------------------------------------------------------------- +# Main logic +# ----------------------------------------------------------------------------- +echo -e "\nFeynman Builder Version $VERSION" +echo -e "\nCopyright (C) 2022" +echo -e "Sameer Rahmani " +echo -e "Feynman comes with ABSOLUTELY NO WARRANTY;" +echo -e "This is free software, and you are welcome" +echo -e "to redistribute it under certain conditions;" +echo -e "for details take a look at the LICENSE file.\n" + +# Find the subcommand in the functions and run we find it. +for fn in $(fn-names); do + if [[ $fn == "$command" ]]; then + eval "$fn ${*:2}" + exit $? + fi +done + +# If we couldn't find the command print out the help message +help diff --git a/lisp/test.el b/lisp/test.el new file mode 100644 index 0000000..84041b8 --- /dev/null +++ b/lisp/test.el @@ -0,0 +1,3 @@ + +(module-load feynman_path) +(message ">> %s" (feynman/init)) diff --git a/scripts/utils.sh b/scripts/utils.sh new file mode 100644 index 0000000..1114be3 --- /dev/null +++ b/scripts/utils.sh @@ -0,0 +1,56 @@ +#! /bin/bash +# Serene Programming Language +# +# Copyright (c) 2019-2022 Sameer Rahmani +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 2. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +set -e + +# ----------------------------------------------------------------------------- +# Helper functions +# ----------------------------------------------------------------------------- +function fn-names() { + grep -E '^function [0-9a-zA-Z_-]+\(\) \{ ## .*$$' "$0" | sed 's/^function \([a-zA-Z0-9_-]*\)() { ## \(.*\)/\1/' +} + +function info() { + if [ "$1" ] + then + echo -e "[\033[01;32mINFO\033[00m]: $*" + fi +} + +function error() { + if [ "$1" ] + then + echo -e "[\033[01;31mERR\033[00m]: $*" + fi +} + +function warn() { + if [ "$1" ] + then + echo -e "[\033[01;33mWARN\033[00m]: $*" + fi +} + +function yes_or_no { + while true; do + read -rp "$* [y/n]: " yn + case $yn in + [Yy]*) return 0 ;; + [Nn]*) echo "Aborted" ; return 1 ;; + esac + done +} diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt new file mode 100644 index 0000000..ecebbb1 --- /dev/null +++ b/src/CMakeLists.txt @@ -0,0 +1,38 @@ +# Feynman -- Wayland compositor for GNU Emacs +# +# Copyright (c) 2022 Sameer Rahmani +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 2. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +add_library(feynman SHARED + feynman.c + ) + +set_target_properties(feynman PROPERTIES + VERSION ${PROJECT_VERSION} + SOVERSION ${PROJECT_VERSION_MAJOR} + # Warn on unused libs + LINK_WHAT_YOU_USE TRUE + C_INCLUDE_WHAT_YOU_USE "${iwyu_path}" + + # LTO support + INTERPROCEDURAL_OPTIMIZATION TRUE) + +if(FEYNMAN_ENABLE_TIDY) + set_target_properties(feynman PROPERTIES CXX_CLANG_TIDY ${CLANG_TIDY_PATH}) +endif() + +# Generate the export.h +include(GenerateExportHeader) + +generate_export_header(feynman EXPORT_FILE_NAME ${PROJECT_BINARY_DIR}/src/export.h) diff --git a/src/feynman.c b/src/feynman.c new file mode 100644 index 0000000..a50c3c4 --- /dev/null +++ b/src/feynman.c @@ -0,0 +1,75 @@ +/* + * Feynman -- Wayland compositor for GNU Emacs + * + * Copyright (c) 2022 Sameer Rahmani + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, version 2. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +#include "export.h" +#include + +/* Declare mandatory GPL symbol. */ +FEYNMAN_EXPORT int plugin_is_GPL_compatible = 0; + +/* New emacs lisp function. All function exposed to Emacs must have this + * prototype. */ +static emacs_value feynman_init(emacs_env *env, ptrdiff_t nargs, + emacs_value args[], void *data) { + (void)nargs; + (void)args; + (void)data; + return env->make_integer(env, 42); +} + +/* Bind NAME to FUN. */ +static void bind_function(emacs_env *env, const char *name, emacs_value Sfun) { + /* Set the function cell of the symbol named NAME to SFUN using + the 'fset' function. */ + + /* Convert the strings to symbols by interning them */ + emacs_value Qfset = env->intern(env, "fset"); + emacs_value Qsym = env->intern(env, name); + + /* Prepare the arguments array */ + emacs_value args[] = {Qsym, Sfun}; + + /* Make the call (2 == nb of arguments) */ + env->funcall(env, Qfset, 2, args); +} + +/* Provide FEATURE to Emacs. */ +static void provide(emacs_env *env, const char *feature) { + /* call 'provide' with FEATURE converted to a symbol */ + + emacs_value Qfeat = env->intern(env, feature); + emacs_value Qprovide = env->intern(env, "provide"); + emacs_value args[] = {Qfeat}; + + env->funcall(env, Qprovide, 1, args); +} + +FEYNMAN_EXPORT int emacs_module_init(struct emacs_runtime *ert) { + emacs_env *env = ert->get_environment(ert); + /* create a lambda (returns an emacs_value) */ + emacs_value fun = env->make_function( + env, 0, /* min. number of arguments */ + 0, /* max. number of arguments */ + feynman_init, /* actual function pointer */ + "Initialize the compositor", /* docstring */ + NULL /* user pointer of your choice (data param in feynman_init) */ + ); + + bind_function(env, "feynman/init", fun); + provide(env, "feynman"); + return 0; +}