path: root/org/config_nix.org

-*- mode: org -*-
#+TITLE:       configuration nix
#+DESCRIPTION: makefile for spine
#+FILETAGS:    :spine:build:tools:
#+AUTHOR:      Ralph Amissah
#+EMAIL:       [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]]
#+COPYRIGHT:   Copyright (C) 2015 - 2022 Ralph Amissah
#+LANGUAGE:    en
#+STARTUP:     content hideblocks hidestars noindent entitiespretty
#+PROPERTY:    header-args  :exports code
#+PROPERTY:    header-args+ :noweb yes
#+PROPERTY:    header-args+ :results no
#+PROPERTY:    header-args+ :cache no
#+PROPERTY:    header-args+ :padline no
#+PROPERTY:    header-args+ :mkdirp yes
#+OPTIONS:     H:3 num:nil toc:t \n:t ::t |:t ^:nil -:t f:t *:t

* nix :nix:

#+NAME: nixpkgs_local
#+BEGIN_SRC sh
/nixpkgs-ra/nixpkgs
#+END_SRC

** NOTES
*** nix-shell

- default.nix

#+BEGIN_SRC sh
nix-shell
nix-build
#+END_SRC

- project.nix

#+BEGIN_SRC sh
nix-shell
nix-build project.nix
#+END_SRC

*** nix-shell --pure

- default.nix

#+HEADER: :noweb yes
#+BEGIN_SRC sh
nix-shell --pure
nix-build -I nixpkgs=<<nixpkgs_local>>
nix-build -I .envrc
#+END_SRC

#+BEGIN_SRC sh
nix build -f default.nix --print-build-logs
nix build -f derivation.nix --print-build-logs
nix shell -f default.nix --print-build-logs
# nix build -f project.nix
# nix build -f spine.nix
nix develop --build -f derivation.nix -I .envrc --print-build-logs
#+END_SRC

*** derivation .drv

#+BEGIN_SRC sh
nix show-derivation /nix/store/q7n14bm8j5vzm62qaraczdb4bpyf59vv-spine-0.11.1.drv
#+END_SRC

** spine

- default.nix
- shell.nix

*** envrc :envrc:
**** .envrc

- https://github.com/nix-community/nix-direnv
  - source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/${NixDirEnvVersion}/direnvrc" "sha256-0000000000000000000000000000000000000000000="

#+HEADER: :tangle ../.envrc
#+BEGIN_SRC sh
use flake .
NIX_ENFORCE_PURITY=1
NixDirEnvVersion="2.1.2"
if ! has nix_direnv_version || ! nix_direnv_version ${NixDirEnvVersion}; then
# - https://github.com/nix-community/nix-direnv
# source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/${NixDirEnvVersion}/direnvrc" "sha256-0000000000000000000000000000000000000000000="
  source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/${NixDirEnvVersion}/direnvrc" "sha256-ytpQmMcUBR2czh8kGOqn/dmD6u55m3lDbeu/G8HGD7A="
fi
if [ -f .envrc-local ]; then
  source_env_if_exists .envrc-local || source .envrc-local
fi
#+END_SRC

- lorri?

#+HEADER: :NO-tangle ../.envrc
#+BEGIN_SRC sh
if type lorri &>/dev/null; then
  echo "direnv: using lorri from PATH ($(type -p lorri))"
  # eval "$(lorri direnv)"
else # fallback prevent bootstrapping problems by using direnv's builtin nix support
  use nix
  NIX_ENFORCE_PURITY=0
fi
if [ -f .envrc-local ]; then
  source_env_if_exists .envrc-local || source .envrc-local
fi
#+END_SRC

- enable flakes

#+HEADER: :NO-tangle ../.envrc
#+BEGIN_SRC sh
if [ -f flake.lock ] && [ -f flake.nix ]; then
    # reload when these files change
    watch_file flake.nix
    watch_file flake.lock
    # load the flake devShell
    if [ ! -d $(direnv_layout_dir) ]; then
        mkdir $(direnv_layout_dir)
    fi
    eval "$(nix --experimental-features 'nix-command flakes' print-dev-env --profile "$(direnv_layout_dir)/flake-profile")"
else
    # fall back to using direnv's builtin nix support
    # to prevent bootstrapping problems.
  #  use nix
  if type lorri &>/dev/null; then
      echo "direnv: using lorri from PATH ($(type -p lorri))"
      eval "$(lorri direnv)"
  else
      # fall back to using direnv's builtin nix support
      # to prevent bootstrapping problems.
      use nix
      NIX_ENFORCE_PURITY=0
  fi
  if [ -f .envrc-local ]; then
    source_env_if_exists .envrc-local || source .envrc-local
  fi
fi
#+END_SRC

**** .envrc-local CHECK MODIFY

- bespoke modify appropriately and generate if needed

#+HEADER: :tangle ../.envrc-local_
#+HEADER: :noweb yes
#+BEGIN_SRC nix
echo ".envrc called .envrc-local"
PATH_add result/bin
export NIX_PATH=/nix/var/nix/profiles/per-user/root/channels/nixos
#export NIX_PATH=nixpkgs=/nixpkgs/nixpkgs
#export NIX_PATH=/nixpkgs/nixpkgs
export DFLAGS="-O2 -inline -boundscheck=on -color=on"
# reload when these files change
# watch_file flake.nix
# watch_file flake.lock
## load the flake devShell
# eval "$(nix print-dev-env)"
# echo $NIX_BUILD_TOP
export Date=`date "+%Y%m%d"`
export SpineVER=$(git describe --long --tags | sed 's/^[ a-z_-]\+\([0-9.]\+\)/\1/;s/\([^-]*-g\)/r\1/;s/-/./g')
export SpinePROJ=~/grotto/repo/git.repo/projects/project-spine/doc-reform
export SpineSRC=$SpinePROJ/src
export SpineBIN=$SpinePROJ/result/bin
export SpineDOC=~/grotto/repo/git.repo/projects/project-spine/doc-reform-markup/spine-markup-samples
export SpinePOD=$SpineDOC/markup/pod
export SpineOUTversioned=/srv/www/spine/$SpineVER
export SpineOUT=/srv/www/spine
export SpineDBpath=/var/www/sqlite
#export SpineDBpath=/srv/www/spine/sqlite
export SpineSearchActionLocal='http://localhost/spine_search'
export SpineSearchActionRemote='https://sisudoc.org/spine_search'
export SpineCGIform='spine_search'
export SpineSQLdb='spine.search.db'
export PROG_VER_GIT="`git describe --long --tags | sed -e 's/^[ a-z_-]\+\([0-9.]\+\)/\1/;s/\([^-]*-g\)/r\1/;s/-/./g'`"
export PROG_VER_DECLARED="`cat ./views/version.txt | grep --color=never "enum" | sed 's/.\+(\([0-9]\+\),[ \t]\+\([0-9]\+\),[ \t]\+\([0-9]\+\)[ \t]*).\+/\1.\2.\3/g'`"
#direnv allow
#+END_SRC

**** .env/echo-nixNote CHECK MODIFY

#+HEADER: :tangle ../.env/echo-nixNote
#+BEGIN_SRC sh
echo '-*- mode: org -*-

,* nixpkgs path?

  # eval "$(nix print-dev-env)"
' > nixNote_.org

echo "  <nixpkgs> == `nix-instantiate --find-file nixpkgs`" >> nixNote_.org

echo '
,* nix build and show derivation

,#+BEGIN_SRC sh
nix-shell --pure

nix-build
nix build -f default.nix --print-build-logs
nix shell -f default.nix --print-build-logs
nix develop --build -f derivation.nix -I .envrc --print-build-logs

nix-instantiate | nix-build

nix-instantiate -I .envrc | nix-build -I .envrc
nix build `nix-instantiate`
nix build `nix-instantiate -I .envrc`

nix develop

nix-instantiate | nix show-derivation | jq
nix-instantiate -I .envrc | nix show-derivation -f derivation.nix -I .envrc | jq

nix-instantiate | nix show-derivation --recursive | jq
nix-instantiate -I .envrc | nix show-derivation -f derivation.nix --recursive -I .envrc | jq

nix search --json 2>/dev/null |jq
,#+END_SRC

,* version and build info

,#+BEGIN_SRC sh' >> nixNote_.org

echo 'spine version (git) == $SpineVER' >> nixNote_.org
echo "spine version (git) == $SpineVER" >> nixNote_.org
echo 'nix-instantiate == `nix-instantiate`' >> nixNote_.org
echo "nix-instantiate == `nix-instantiate`" >> nixNote_.org

echo "#+END_SRC

,* initialised shell variables

,#+BEGIN_SRC sh
SpineSRC=$SpineSRC
SpineDOC=$SpineDOC
SpinePOD=$SpinePOD
SpineOUTversioned=$SpineOUTversioned
SpineOUT=$SpineOUT
,#+END_SRC
" >> nixNote_.org

echo '* spine run instruction examples
,** parallelized tasks
,*** doc source

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --pod --source --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** html & epub output

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --html --epub --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** sqlite db for each document - populate each db

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-discrete --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** doc source; html, epub; sqlite outputs

,#+BEGIN_SRC sh
$SpineBIN/spine --verbose --pod --html --epub --sqlite-discrete --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** curate (authors topics)

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --curate --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** html, curate

,#+BEGIN_SRC sh
$SpineBIN/spine --verbose --dark --html --html-link-curate --curate --output="$SpineOUTversioned" $SpinePOD/*
$SpineBIN/spine --very-verbose --html --html-link-curate --curate --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** composite command: source pod, html, epub, curate, sqlite

,#+BEGIN_SRC sh
$SpineBIN/spine --verbose --dark --pod --epub --html --html-link-curate --curate --sqlite-discrete --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,** sequential tasks
,*** sqlite db (shared) - create db

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-db-create --output="$SpineOUTversioned"
,#+END_SRC

,*** sqlite db (shared) - populate db

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-update --output="$SpineOUTversioned" $SpineDOC/spine-markup-samples/markup/pod/*
,#+END_SRC

,*** sqlite db (shared) - drop db

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-db-drop --output="$SpineOUTversioned"
,#+END_SRC

,*** sqlite db (shared) - create & populate db (single step)

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-db-create --sqlite-update --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,*** composite command: source pod, html, epub, curate, sqlite

,#+BEGIN_SRC sh
$SpineBIN/spine --verbose --no-parallel --dark --pod --epub --html --html-link-curate --curate --sqlite-discrete --output="$SpineOUTversioned" $SpinePOD/*
,#+END_SRC

,** config [./pod/].dr/config_local_site

,#+BEGIN_SRC sh
cat $SpinePOD/.dr/config_local_site
$SpineBIN/spine --show-config $SpinePOD
$SpineBIN/spine --show-config --output="$SpineOUTversioned" $SpinePOD
,#+END_SRC

,** cgi operations (output to $SpineOUT /var/www)

,#+BEGIN_SRC sh
$SpineBIN/spine --very-verbose --sqlite-db-create --output="$SpineOUT" $SpinePOD/*

$SpineBIN/spine -v --cgi-search-form-codegen --output=$SpineOUT $SpinePOD/*

$SpineBIN/spine -v --show-config --config=$SpinePOD/.dr

$SpineBIN/spine --html $SpinePOD/*


$SpineBIN/spine -v --cgi-search-form-codegen --config=$SpinePOD/.dr/config_local_site
,#+END_SRC

,*** generate html linked to search form

,#+BEGIN_SRC sh
$SpineBIN/spine -v --html --html-link-search --html-link-curate --curate  --output=$SpineOUT $SpinePOD/*
,#+END_SRC

,*** create or re-create sql db (--sqlite-db-create or --sqlite-db-recreate)

,#+BEGIN_SRC sh
$SpineBIN/spine -v --sqlite-db-create --sqlite-db-filename="<<spine_search_db>>" --sqlite-db-path="$SpineDBpath"
$SpineBIN/spine -v --sqlite-db-recreate --sqlite-db-filename="<<spine_search_db>>" --sqlite-db-path="$SpineDBpath"
,#+END_SRC

,*** populate sqlite db

,#+BEGIN_SRC sh
$SpineBIN/spine -v --sqlite-update --sqlite-db-filename="<<spine_search_db>>" --output=$SpineOUT $SpinePOD/*
,#+END_SRC

,*** generate html (linked to search form), sql output, curate COMPOSITE

,#+BEGIN_SRC sh
$SpineBIN/spine -v --html --html-link-search --html-link-curate --curate --sqlite-update --sqlite-db-filename="<<spine_search_db>>" --cgi-sqlite-search-filename="<<spine_search_cgi>>" --sqlite-db-path="$SpineDBpath" --output="$SpineOUT" $SpinePOD/*
$SpineBIN/spine --epub --html --html-link-search --html-link-curate --curate --sqlite-update --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine_search" --cgi-url-action="https://sisudoc.org/spine_search" --ouput="$SpineOUT" $SpinePOD/*
,#+END_SRC

,*** generate html (linked to search form), sql output, curate COMPOSITE with resource configuration

if names and paths are configured in resource configuration file, e.g. $SpinePOD/.rc/config_local_site

,#+BEGIN_SRC sh
$SpineBIN/spine -v --html --html-link-search --html-link-curate --curate --sqlite-update $SpinePOD/*
,#+END_SRC

,#+BEGIN_SRC yaml
# sample resource configuration file ( $SpinePOD/.rc/config_local_site )
output:
  path:                        "/srv/www/spine"
default:
  language:                    "en"
  papersize:                   "a4"
  text_wrap:                   "80"
  digest:                      "sha256"
webserv:
  http:                        "http"
  domain:                      "localhost"
  data_http:                   "http"
  data_domain:                 "localhost"
  data_root_url:               "https://sisudoc.org"
  data_root_path:              "/srv/www/spine"
  images_root_part:            "image"
  cgi_search_form_title:       "≅ SiSU Spine search"
  cgi_http:                    "https"
  cgi_domain:                  "sisudoc.org"
  cgi_bin_url:                 "http://sisudoc.org/cgi-bin"
  cgi_bin_part:                "cgi-bin"
  cgi_bin_path:                "/var/www/cgi/cgi-bin"
  cgi_search_script:           "<<spine_search_cgi>>"
  cgi_action:                  "https://sisudoc.org/spine_search"
  db_sqlite_filename:          "<<spine_search_db>>"
  db_sqlite_path:              "/var/www/sqlite"
,#+END_SRC

,*** make search form

,#+BEGIN_SRC sh
$SpineBIN/spine -v --cgi-search-form-codegen --config=$SpinePOD/.dr/config_local_site
,#+END_SRC

,*** latex

,#+BEGIN_SRC sh
$SpineBIN/spine --latex --serial --output="$SpineOUT" $SpinePOD/*
ls $SpineOutstatic/latex/*.tex
,#+END_SRC
' >> nixNote_.org

#cat nixNote_.org

#echo "emacs nixNote_.org"
#echo "cat nixNote_.org"
#+END_SRC

*** makefile

#+HEADER: :tangle ../makefile_
#+BEGIN_SRC make
buildPhase:
	HOME=$${PWD}; \
	for DC_ in dmd ldmd2 gdmd; do \
	  echo "- check for D compiler $${DC_}"; \
	  DC=$$(type -P $${DC_} || echo ""); \
	  if [ ! "$${DC}" == "" ]; then \
	    break; \
	  fi; \
	done; \
  echo "D compiler = $${DC}"; \
	if [ "$${DC}" == "" ]; then \
    echo "Error: could not find D compiler"; \
	  exit 1; \
	fi; \
	echo "$${DC_} used as D compiler to build $${pname}"; \
	export DFLAGS="-O2 -inline"; \
	dub build --compiler=$${DC} --build=release --combined --skip-registry=all;
checkPhase:
	runHook preCheck; \
	HOME=$${PWD}; \
	dub test --combined --skip-registry=all; \
	runHook postCheck
installPhase:
	runHook preInstall; \
	mkdir -p $${out}/bin; \
	install -m755 ./bin/spine $${out}/bin/spine; \
	runHook postInstall
	#cp -r bin/spine $out/bin/.
postInstall:
	echo "$${out}/share/cgi-bin"; \
	echo `ls -la $${out}/bin/spine`
#+END_SRC

*** flake :flake:

- flake.nix
    /nixpkgs-ra/nixpkgs
    ./shell.nix
  - shell.nix
      ./pkgs/shell-pkgs.nix
    - pkgs/shell-pkgs.nix
  - default.nix
     ./nix/dub.selections.nix #
    - dub.selections.nix

- nix develop

- nix flake update

- nix shell -f default.nix --print-build-logs
- nix shell -c default.nix

- nix build `nix-instantiate`
- nix build -f default.nix --print-build-logs
- nix shell -f default.nix --print-build-logs
- nix develop --build -f derivation.nix -I .envrc --print-build-logs

- nix search --json 2>/dev/null |jq
- nix flake show
- nix show-derivation

# nix-instantiate | nix-build

#+HEADER: :tangle ../flake.nix
#+HEADER: :noweb yes
#+BEGIN_SRC nix
{
  description = "a sisu like parser and document generator";
  inputs.flake-utils.url = "github:numtide/flake-utils";
  inputs.nixpkgs.url = "github:nixos/nixpkgs";
  #inputs.nixpkgs.url = "/nixpkgs-ra/nixpkgs";
  outputs = { self, nixpkgs, flake-utils }: {
    packages.x86_64-linux.spine =
      let
        pkgs = import nixpkgs {
          system = "x86_64-linux";
        };
        #targetOf = package: "${package.targetPath or "."}/${package.targetName or package.name}";
      in pkgs.stdenv.mkDerivation {
        pname       = "spine";
        version     = "<<spine_version_set>>";
        description = "a sisu like parser and document generator";
        inherit self;
        src = self;
        shell = ./shell.nix;
        buildPhase = ''
          runHook preBuild
          HOME="$PWD"
          DFLAGS="-O2 -inline"
          for DC_ in dmd ldmd2 gdmd; do
            echo "- check for D compiler $DC_"
            DC=$(type -P $DC_ || echo "")
            if [ ! "$DC" == "" ]; then break; fi
          done
          if [ "$DC" == "" ]; then
            exit "Error: could not find D compiler"
          fi
          echo "$DC_ used as D compiler to build $pname"
          dub build --compiler=$DC --build=release --combined --skip-registry=all
          runHook postBuild
        '';
        checkPhase = ''
          runHook preCheck
          HOME="$PWD"
          dub test --combined --skip-registry=all
          runHook postCheck
        '';
        installPhase = ''
          runHook preInstall
          mkdir -p $out/bin
          install -m755 ./bin/spine $out/bin/spine
          #cp -r bin/spine $out/bin/.
          runHook postInstall
        '';
        postInstall = ''
          echo `ls -la $out/bin/spine`
          echo ""
          echo "nix build or nix develop? (suggestions):"
          echo '- nix build'
          echo '  nix build .#spine --print-build-logs'
          echo '    nix build --print-build-logs'
          echo '- nix run'
          echo '  nix run .#spine --print-build-logs'
          echo '  nix run default.nix --print-build-logs'
          echo '- nix shell'
          echo '  nix shell --print-build-logs --command spine -v'
          echo '- nix develop'
          echo '  nix develop --build -f derivation.nix -I .envrc --print-build-logs'
          echo '    nix develop ; eval "$buildPhase"'
          echo 'spine -v'
          echo 'nix-instantiate | nix show-derivation | jq'
          echo `ls -la $out/bin/spine`
          echo "built:"
          $out/bin/spine -v
        '';
        nativeBuildInputs = with pkgs; [ ldc dub ];
        buildInputs = with pkgs; [ sqlite ];
     };
     packages.x86_64-linux.default = self.packages.x86_64-linux.spine;
  };
}

#nix flake update
#nix flake check
#nix flake show
#nix develop
#nix build .#default --print-build-logs
#+END_SRC

#+BEGIN_SRC nix
src = fetchTarball {
  url       = "file:///[path]/$(pname)-$(version).tar.gz";
  sha256    = "sha256:0000000000000000000000000000000000000000000000000000";
};
#+END_SRC
#+HEADER: :noweb yes
#+BEGIN_SRC nix
{
  description = "a sisu like parser & document generator";
  inputs = {
    flake-utils.url = "github:numtide/flake-utils";
    nixpkgs.url = "<<nixpkgs_url>>";
  };
  outputs = { self, nixpkgs, flake-utils }:
  let
    pkgs = nixpkgs.legacyPackages.x86_64-linux;
  in {
    packages.x86_64-linux.spine = pkgs.stdenv.mkDerivation {
      name = "spine";
      inherit self;
      src = self;
      shell = ./shell.nix;
      installPhase = ''
         install -m755 spine $out/bin/spine
      '';
    };
    defaultPackage.x86_64-linux = self.packages.x86_64-linux.spine;
  };
}
#+END_SRC

#+HEADER: :noweb yes
#+BEGIN_SRC nix
{
  description = "a sisu like document parser";
  inputs = {
    flake-utils.url = "github:numtide/flake-utils";
    nixpkgs.url = "<<nixpkgs_url>>";
    d2sqlite3 = {
      url    = "github:dlang-community/d2sqlite3";
      flake  = false;
    };
    tinyendian = {
      url    = "github:kiith-sa/tinyendian";
      flake  = false;
    };
    dyaml = {
      url    = "github:dlang-community/D-YAML";
      flake  = false;
    };
    imageformats = {
      url    = "github:lgvz/imageformats";
      flake  = false;
    };
  };
  outputs = { self, d2sqlite3, tinyendian, dyaml, imageformats, nixpkgs, flake-utils }:
  let
    pkgs = nixpkgs.legacyPackages.x86_64-linux;
  in {
    packages.x86_64-linux.spine = pkgs.stdenv.mkDerivation {
      name = "spine";
      inherit self;
      src = self;
      shell = ./shell.nix;
      installPhase = ''
         install -m755 spine $out/bin/spine
      '';
    };
    defaultPackage.x86_64-linux = self.packages.x86_64-linux.spine;
  };
}
#+END_SRC

*** shell.nix :shell:
**** tangle

#+HEADER: :tangle ../shell.nix
#+HEADER: :tangle-mode (identity #o755)
#+HEADER: :shebang "#!/usr/bin/env -S nix-shell --pure\n#!nix-shell -i bash"
#+HEADER: :noweb yes
#+BEGIN_SRC nix
{ pkgs ? import <nixpkgs> {} }:
with pkgs;
mkShell {
  buildInputs = [
    direnv
    nixVersions.unstable #nixFlakes
    nix-prefetch-git
    validatePkgConfig
    nix-tree jq nix-output-monitor
    git
    ps
    ### d_build_related
    dub
    ## compiler
    ldc
    rund
    ## linker
    #lld
    #mold
    ## builder
    #ninja
    #meson
    ### sqlite search related
    sqlite
    # ### pdf_latex_related
    # source-sans-pro
    # source-serif-pro
    # source-code-pro
    # texlive.combined.scheme-full
    # ### xml_and_epub_related
    # libxml2
    # html-tidy
    # xmlstarlet
    # epubcheck
    # ebook_tools
    # epr
    # sigil
    # calibre #(suite includes: ebook-viewer)
    # foliate
    # ### i18n translation related
    # perl534Packages.Po4a
    ### candy
    starship
  ];
  shellHook = ''
    #if [[ -f ".envrc" ]]; then
    #  source .envrc
    #fi
    nix flake update
    echo ""
    echo "nix flake metadata:"
    nix flake metadata
    echo ""
    echo "nix flake check:"
    nix flake check
    echo ""
    echo "nix flake show:"
    nix flake show
    echo "
      nix flake update
      nix flake metadata
      nix flake check
      nix flake show

      nix build or nix develop? (suggestions):

      - nix build
        nix build .#default --print-build-logs
        nix build --print-build-logs
        nix build .#default --print-build-logs |& nom

      - nix run
        nix run .#spine --print-build-logs
        nix run default.nix --print-build-logs

      - nix shell
        nix shell --print-build-logs --command spine -v

      - nix develop
        nix develop --build  .#default --print-build-logs
        nix develop --build -f derivation.nix -I .envrc --print-build-logs
        nix develop ; eval \$buildPhase

        nix-build |& nom

      spine -v

      nix-instantiate | nix show-derivation | jq
      nix-build . --no-out-link | xargs -o nix-tree
      nix-tree --derivation .#spine

    "
    #echo "ldc `${pkgs.ldc}/bin/ldc2 -v`"
  '';
}
#+END_SRC

**** Notes

#+BEGIN_SRC text
#% Notes

# - shell.nix -I .envrc
# - shell.nix -I .envrc --pure

# [ nix-shell ]

  # - nix-shell -I nixpkgs=/nixpkgs-ra/nixpkgs --pure
  # - nix-shell -p "with import /nixpkgs-ra/nixpkgs {}; ldc" --pure
  # - nix-shell -p "with import /nixpkgs-ra/nixpkgs {}; [dub ldc]" --pure

  # - nix-shell -p nixVersions.unstable #nixFlakes
  # - nix-shell -p nixFlakes --pure
  # - nix-shell -p nixFlakes --pure -p "with import /nixpkgs-ra/nixpkgs {}; [nix dub ldc git ps]"
  # - nix-shell shell.nix direnv: export +IN_NIX_SHELL
  # - nix-shell shell.nix

# [ nix-build ]

  # - nix-build -I nixpkgs=/nixpkgs-ra/nixpkgs # --pure
  # - nix-build -I .envrc --pure
  # - nix-build default.nix -I .envrc && result/bin/spine -v

# [ nix-instantiate ]

  # - nix-instantiate | nix show-derivation | jq
  # - nix-instantiate -I .envrc | nix show-derivation -f derivation.nix -I .envrc | jq
  # - nix-instantiate | nix show-derivation --recursive | jq
  # - nix-instantiate -I .envrc | nix show-derivation -f derivation.nix --recursive -I .envrc | jq
  # - nix-instantiate | nix-build
  # - nix-instantiate -I .envrc | nix-build -I .envrc

# [ nix shell ]

  # - nix shell -c default.nix
  # - nix shell -f default.nix --print-build-logs

# [ nix build ]

  # - nix build -I .envrc --print-build-logs
  # - nix build -f default.nix --print-build-logs
  # - nix build -f derivation.nix --print-build-logs

  # - nix build `nix-instantiate`
  # - nix build `nix-instantiate -I .envrc`

  # - nix build -f default.nix && ./result/bin/spine -v && noti -t "spine build" -m "see ./result/bin/spine"
  # - nix build .#spine

# [ nix run ]

  # - nix run default.nix --print-build-logs
  # - nix run -I .envrc default.nix --print-build-logs
  # - nix run .#spine

# - nix-shell -I .envrc --pure
# - nix develop --build -f derivation.nix -I .envrc --print-build-logs

# - nix-shell -p nixFlakes --pure -p "with import /nixpkgs-ra/nixpkgs {}; [nix dub ldc git ps]"
# - nix-build
# - nix build `nix-instantiate -I .envrc`

# - nix develop --build -f default.nix -I .envrc

# - nix-shell -I .envrc --pure
# - nix-build default.nix -I .envrc && result/bin/spine -v

# - nix shell -f default.nix --print-build-logs
# - nix-instantiate -I .envrc | nix-build -I .envrc
#+END_SRC

#+BEGIN_SRC text
#% Notes
- nix-shell

- shell.nix --pure
- shell.nix --pure -I .envrc

- nix-shell --pure -I nixpkgs=<<nixpkgs_local>>
- nix-shell --pure -p "with import <<nixpkgs_local>> {}; ldc"
- nix-shell --pure -p "with import /nixpkgs-ra/nixpkgs {}; [dub ldc]"

- shell.nix direnv: export +IN_NIX_SHELL

- nix-shell -p nixFlakes
- nix-shell -p nixFlakes --pure
- nix-shell -p nixFlakes --pure -p "with import /nixpkgs-ra/nixpkgs {}; [dub ldc]"

- shell.nix -I .envrc
- nix-shell -I nixpkgs=<provide local nix path>
- nix-shell -I nixpkgs=<provide local nix path> --pure
- shell.nix
- nix-shell shell.nix --pure

- nix shell -c default.nix

- nix run default.nix --print-build-logs
- nix run -I .envrc default.nix --print-build-logs

- nix develop

- nix-build -I nixpkgs=<provide local nix path>
- nix-build -I .envrc

- nix build -f default.nix --print-build-logs
- nix build -f derivation.nix --print-build-logs
- nix build -I .envrc --print-build-logs
- nix shell -f default.nix --print-build-logs
- nix develop --build -f derivation.nix -I .envrc --print-build-logs

- buildPhase

- nix build -f default.nix && noti
- nix build -f default.nix && ./result/bin/spine -v && noti -t "spine build" -m "see ./result/bin/spine"
- nix develop --build -f derivation.nix -I .envrc --print-build-logs

  ./result/bin/spine
#+END_SRC

**** parts
***** packages nix related

#+NAME: shell_packages_nix_related
#+BEGIN_SRC nix
### nix_related
direnv
nixVersions.unstable #nixFlakes
nix-prefetch-git
validatePkgConfig
jq
git
ps
#+END_SRC

***** packages d build related

#+NAME: shell_packages_d_build_related
#+BEGIN_SRC nix
### d_build_related
## package manager
dub
## compiler
ldc
rund
## linker
#lld
#mold
## builder
#ninja
#meson
#+END_SRC

***** packages tools

#+NAME: shell_packages_tool_download
#+BEGIN_SRC nix
### tools
#curl
#wget
aria
#+END_SRC

***** packages candy

#+NAME: shell_packages_candy
#+BEGIN_SRC nix
### candy
starship
#+END_SRC

***** packages search sqlite related

#+NAME: shell_packages_search_related_sqlite
#+BEGIN_SRC nix
### sqlite search related
sqlite
#+END_SRC

***** packages pdf latex related

#+NAME: shell_packages_pdf_latex_related
#+BEGIN_SRC nix
### pdf_latex_related
source-sans-pro
source-serif-pro
source-code-pro
texlive.combined.scheme-full
#+END_SRC

***** packages xml epub related

#+NAME: shell_packages_xml_and_epub_related
#+BEGIN_SRC nix
### xml_and_epub_related
libxml2
html-tidy
xmlstarlet
epubcheck
ebook_tools
epr
sigil
calibre #(suite includes: ebook-viewer)
foliate
#+END_SRC

***** packages i18n_translation related

#+NAME: shell_packages_i18n_translation
#+BEGIN_SRC nix
### i18n translation related
perl534Packages.Po4a
#+END_SRC

**** misc

#+HEADER: :NO-tangle ../shell.nix
#+HEADER: :tangle-mode (identity #o755)
#+HEADER: :shebang "#!/usr/bin/env -S nix-shell"
#+BEGIN_SRC nix
{ pkgs ? import <nixpkgs> {} }:
pkgs.mkShell {
  buildInputs = with pkgs; [
    (import ./nix/pkglst/shell-pkgs.nix { inherit pkgs; })
  ];
  buildPhase = "nix build -f default.nix";
  shellHook = ''
    echo "built spine @ ./result/bin/spine"
    if [[ -f ".envrc" ]]; then
      source .envrc
    fi
    nix-instantiate | nix show-derivation | jq
  '';
}
#+END_SRC

*** default.nix :default:

- default.nix -I nixpkgs=<provide local nix path>
  e.g. default.nix -I nixpkgs=/nixpkgs-ra/nixpkgs

- nix-build -I nixpkgs=<provide local nix path>
  e.g. nix-build -I nixpkgs=<<nixpkgs_local>>

#+HEADER: :noweb yes
#+BEGIN_SRC sh
nix-build -I nixpkgs=<<nixpkgs_local>>
nix-build -I .envrc-local
nix-build -I .envrc
default.nix -I .envrc
default.nix

nix build -f default.nix --print-build-logs
nix build -f derivation.nix --print-build-logs
nix shell -f default.nix --print-build-logs
nix develop --build -f derivation.nix -I .envrc --print-build-logs

# nix build -f project.nix
# nix build -f spine.nix
#+END_SRC

#+HEADER: :tangle ../default.nix
#+HEADER: :tangle-mode (identity #o755)
#+HEADER: :shebang "#!/usr/bin/env -S nix-build"
#+BEGIN_SRC nix
{ pkgs ? import <nixpkgs> {} }:
pkgs.callPackage ./derivation.nix {}
#+END_SRC

*** derivation.nix :default:

#+HEADER: :tangle ../derivation.nix
#+HEADER: :tangle-mode (identity #o644)
#+HEADER: :noweb yes
#+BEGIN_SRC nix
{ pkgs ? import <nixpkgs> {},
  stdenv ? pkgs.stdenv,
  lib ? pkgs.lib,
  ldc ? null,
  dcompiler ? pkgs.ldc,
  dub ? pkgs.dub
}:
assert dcompiler != null;
with (
  with lib;
  let
    filterDub = name: type: let baseName = baseNameOf (toString name); in ! ( # filter function to remove the .dub package folder from src
      type == "directory" && baseName == ".dub"
    );
    targetOf = package: "${package.targetPath or "."}/${package.targetName or package.name}";
    # remove reference to build tools and library sources
    disallowedReferences = deps: [ dcompiler dub ];
    removeExpr = refs: ''remove-references-to ${lib.concatMapStrings (ref: " -t ${ref}") refs}'';
  in {
    mkDubDerivation = lib.makeOverridable ({
      src,
      nativeBuildInputs ? [],
      dubJSON ? src + "/dub.json",
      passthru ? {},
      package ? lib.importJSON dubJSON,
      ...
    } @ attrs: stdenv.mkDerivation (attrs // {
      pname = package.name;
      nativeBuildInputs = [ dcompiler dub pkgs.removeReferencesTo ] ++ nativeBuildInputs;
      disallowedReferences = disallowedReferences deps;
      passthru = passthru // {
        inherit dub dcompiler pkgs;
      };
      src = lib.cleanSourceWith {
        filter = filterDub;
        src = lib.cleanSource src;
      };
      preFixup = ''
        find $out/bin -type f -exec ${removeExpr (disallowedReferences deps)} '{}' + || true
      '';
      buildPhase = ''
        runHook preBuild
        HOME="$PWD"
        DFLAGS="-O2 -inline"
        for DC_ in dmd ldmd2 gdmd; do
          echo "- check for D compiler $DC_"
          DC=$(type -P $DC_ || echo "")
          if [ ! "$DC" == "" ]; then
            break
          fi
        done
        if [ "$DC" == "" ]; then
          exit "Error: could not find D compiler"
        fi
        echo "$DC_ used as D compiler to build $pname"
        dub build --compiler=$DC --build=release --combined --skip-registry=all
        runHook postBuild
      '';
      checkPhase = ''
        runHook preCheck
        HOME="$PWD"
        dub test --combined --skip-registry=all
        runHook postCheck
      '';
      installPhase = ''
        runHook preInstall
        mkdir -p $out/bin
        cp -r "${targetOf package}" $out/bin
        runHook postInstall
      '';
      meta = lib.optionalAttrs (package ? description) {
        description = package.description;
      } // attrs.meta or {};
    } // lib.optionalAttrs (!(attrs ? version)) {
      name = package.name; # use name from dub.json, unless pname and version are specified
    }));
  }
);
mkDubDerivation rec {
  pname         = "spine";
  version       = "<<spine_version_set>>";
  src           = ./.;
  nativeBuildInputs = with pkgs; [ dub ldc ];
  buildInputs = with pkgs; [ nixVersions.unstable sqlite ];
  meta = with pkgs.lib; {
    description = "A sisu like parser and document generator";
    longDescription = ''
      A sisu like parser and document generator
    '';
    homepage    = "https://sisudoc.org";
    license     = licenses.agpl3Plus;
    platforms   = platforms.linux;
    maintainers = [ "RalphAmissah" ];
  };
}
#+END_SRC

- unused
  - installPhase

#+BEGIN_SRC txt
installPhase = ''
  mkdir -p $out/bin
  cp spine $out/bin
  chmod +x $out/bin/spine
'';
#+END_SRC

*** project meta

#+NAME: nix_project_meta
#+HEADER: :noweb yes
#+BEGIN_SRC nix
meta = with pkgs.lib; {
  pname       = "spine";
  version     = "<<spine_version_set>>";
  description = "a sisu like document parser";
  longDescription = ''
    A sisu like parser and document generator
  '';
  homepage    = "https://sisudoc.org";
  license     = licenses.agpl3Plus;
  platforms   = platforms.linux;
  maintainers = [ "RalphAmissah" ];
};
#+END_SRC

*** dub.selections.json

#+HEADER: :NO-tangle ../dub.selections.json
#+BEGIN_SRC nix
{
	"fileVersion": 1,
	"versions": {
		"d2sqlite3": "0.19.1",
		"dyaml": "0.8.3",
		"imageformats": "7.0.2",
		"tinyendian": "0.2.0"
	}
}
#+END_SRC

*** dub.selections.nix

#+HEADER: :NO-tangle ../nix/dub.selections.nix
#+BEGIN_SRC nix
# This file was generated by https://github.com/lionello/dub2nix v0.2.3
[ {
  fetch = {
    type = "git";
    url = "https://github.com/dlang-community/d2sqlite3.git";
    rev = "v0.19.1";
    sha256 = "0rnsgla6xyr8r34knf7v6dwhacra96q1b5rhxcz9246inwhvrk5k";
    fetchSubmodules = false;
    date = "2020-07-21T12:32:51+02:00";
    deepClone = false;
    leaveDotGit = false;
    path = "/nix/store/hsi8xvl15w6fwlqvs042m1z5i88yc72i-d2sqlite3";
  };
} {
  fetch = {
    type = "git";
    url = "https://github.com/kiith-sa/tinyendian.git";
    rev = "v0.2.0";
    sha256 = "086gf5aga52wr5rj2paq54daj8lafn980x77b706vvvqaz2mlis8";
    fetchSubmodules = false;
    date = "2018-06-10T11:04:28+02:00";
    deepClone = false;
    leaveDotGit = false;
    path = "/nix/store/9c7fsmi5am84j6dq2mp3va306x3ay291-tinyendian";
  };
} {
  fetch = {
    type = "git";
    url = "https://github.com/kiith-sa/D-YAML.git";
    rev = "v0.8.3";
    sha256 = "13wy304xjbwkpgg7ilql1lkxkm83s87jm59ffnrg26slp7cx149q";
    fetchSubmodules = false;
    date = "2020-09-19T23:46:57+02:00";
    deepClone = false;
    leaveDotGit = false;
    path = "/nix/store/3i8i56lkmw2xq3lxr5h66v909waq2mqg-D-YAML";
  };
} {
  fetch = {
    type = "git";
    url = "https://github.com/lgvz/imageformats.git";
    rev = "v7.0.2";
    sha256 = "1mfbsmi4fs1xny4zqs6jyr04d5f4h03r9f6jadvkdqj5kd1k0ws7";
    fetchSubmodules = false;
    date = "2019-10-10T07:54:45+03:00";
    deepClone = false;
    leaveDotGit = false;
    path = "/nix/store/wn554pn21nzmpvw2hs7hvv9v9y0sgarg-imageformats";
  };
} ]
#+END_SRC

*** dub2nix & shared pkgs SHARED
**** dub2nix with pkgs shared

#+NAME: nix_with_pkgs
#+HEADER: :noweb yes
#+BEGIN_SRC nix
with pkgs; [
  <<nix_shell_with_pkgs_list>>
]
#+END_SRC

**** with pkgs list

#+NAME: nix_shell_with_pkgs_list
#+BEGIN_SRC nix
nixVersions.unstable #nixFlakes
rund
dub
ldc
sqlite
nix-prefetch-git
validatePkgConfig
jq
git
#+END_SRC

** variables
*** spine version SET VERSION :version:set:project:

#+NAME: spine_version_set
#+BEGIN_SRC sh
0.12.0
#+END_SRC

*** set names SET

#+NAME: spine_search_db
#+BEGIN_SRC sh
spine.search.db
#+END_SRC

#+NAME: spine_search_cgi
#+BEGIN_SRC sh
spine_search
#+END_SRC

*** nixpkgs_path SETUP
**** nixpkgs select path SELECT

#+NAME: nixpkgs_path
#+HEADER: :noweb yes
#+BEGIN_SRC nix
<<nixpkgs_path_local>>
#+END_SRC

**** nixpkgs path options

- <nixpkgs>

#+NAME: nixpkgs_path_default
#+HEADER: :noweb yes
#+BEGIN_SRC nix
<nixpkgs>
#+END_SRC

#+NAME: nix_path_directory
#+HEADER: :noweb yes
#+BEGIN_SRC nix
nixpkgs=<<nixpkgs_path_local>>
#+END_SRC

#+NAME: project_path_local_project
#+HEADER: :noweb yes
#+BEGIN_SRC nix
~/grotto/repo/git.repo/projects/project-spine/doc-reform
#+END_SRC

#+NAME: project_path_local_src
#+HEADER: :noweb yes
#+BEGIN_SRC nix
<<project_path_local_project>>/src
#+END_SRC

#+NAME: project_path_local_bin
#+HEADER: :noweb yes
#+BEGIN_SRC nix
<<project_path_local_project>>/result/bin
#+END_SRC

#+NAME: project_path_cgi_bin
#+BEGIN_SRC nix
/var/www/cgi/cgi-bin
#+END_SRC

#+NAME: project_path_local_doc
#+BEGIN_SRC nix
~/grotto/repo/git.repo/projects/project-spine/doc-reform-markup/spine-markup-samples
#+END_SRC

#+NAME: project_path_local_out
#+BEGIN_SRC nix
/srv/www/spine/$SpineVER
#+END_SRC

#+NAME: project_path_local_out_
#+HEADER: :noweb yes
#+BEGIN_SRC nix
/tmp/spine/$SpineVER/www
#+END_SRC

#+NAME: project_path_local_out_static
#+HEADER: :noweb yes
#+BEGIN_SRC nix
/srv/www/spine
#+END_SRC

#+NAME: project_path_local_out_static_
#+BEGIN_SRC nix
/var/www
#+END_SRC

#+NAME: project_path_sqlite
#+BEGIN_SRC nix
/var/www/sqlite
#+END_SRC

#+NAME: nixpkgs_url
#+BEGIN_SRC nix
github:nixos/nixpkgs
#+END_SRC

#+HEADER: :noweb yes
#+BEGIN_SRC nix
<<nixpkgs_path_local>>
#+END_SRC

- local path SET WARN

#+NAME: nixpkgs_path_local
#+BEGIN_SRC nix
/nixpkgs-ra/nixpkgs
#+END_SRC

**** project path options

- local path SET WARN

#+NAME: nix_path_channel
#+BEGIN_SRC nix
/nix/var/nix/profiles/per-user/root/channels/nixos
#+END_SRC

** texlive xetex xelatex shell.nix
*** shell.nix :shell:

#+BEGIN_SRC nix
#!/usr/bin/env -S nix-shell --pure
{ pkgs ? import <nixpkgs> {} }:
pkgs.mkShell {
  buildInputs = with pkgs; [
    nixVersions.unstable #nixFlakes
    nix-prefetch-git
    validatePkgConfig
    jq
    git
    fontconfig
    source-sans-pro
    source-serif-pro
    source-code-pro
    #(texlive.combine {
    #  inherit (texlive) scheme-tetex xetex fontspec footmisc multirow titlesec listings anysize float graphics helvetic times courier;
    #})
    texlive.combined.scheme-full
    dejavu_fonts dejavu_fontsEnv
    liberation_ttf
    evince
    zathura
    apvlv
  ];
    #FONTCONFIG_FILE = makeFontsConf { fontDirectories = [
    #  liberation_ttf
    #];
  shellHook = ''
    if [[ -f ".envrc" ]]; then
      source .envrc
    fi
    #for texfile in *.tex; do xelatex -interaction=nonstopmode $texfile; done
    #for texfile in *.tex; do xelatex -interaction=batchmode $texfile; done
  '';
}
#+END_SRC

*** notes

#+BEGIN_SRC sh
nix-shell --run 'which xetex'
echo 'for texfile in *.tex; do echo "* --> " ~ $texfile && xelatex -interaction=batchmode $texfile; rm *.aux *.log *.toc *.out; done'

$SpineBIN/spine --latex --serial --output="$SpineOUT" $SpinePOD/* && for texfile in $SpineOUT/latex/*.tex; do xelatex -interaction=nonstopmode $texfile; done 2>&1 | tee _err.xelatex_.org; ls $SpineOUT/latex/*.{tex,pdf}

/run/current-system/sw/share/X11/fonts/

kpsewhich pdftexconfig.tex
/nix/store/2r4qa8rbll085nmpx56jg1rbmbir1zkp-texlive-combined-2021/share/texmf/tex/generic/tex-ini-files/pdftexconfig.tex
/nix/store/2r4qa8rbll085nmpx56jg1rbmbir1zkp-texlive-combined-2021/share/texmf/fonts/opentype/public/

find: texclive-fonts.conf
fc-cache && mkfontscale && mkfontdir

fc-match LiberationSans

cd /nix/var/nix/profiles/system/sw/share/X11/fonts
fc-query LiberationSans-Regular.ttf | grep '^\s\+family:' | cut -d'"' -f2
Liberation Sans
fc-query LiberationMono-Regular.ttf | grep '^\s\+family:' | cut -d'"' -f2
Liberation Mono

fc-query DejaVuSans.ttf | grep '^\s\+family:' | cut -d'"' -f2

$XDG_DATA_HOME/fonts
~/.local/share/fonts
#+END_SRC