diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000000000000000000000000000000000000..80b570ad469789f4b331d2aedcb92659e240b162 --- /dev/null +++ b/.clang-format @@ -0,0 +1,99 @@ +--- +Language: Cpp +BasedOnStyle: Chromium +AccessModifierOffset: -2 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: true +AlignConsecutiveDeclarations: true +AlignOperands: true +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: All +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: true +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterClass: false + AfterControlStatement: false + AfterEnum: false + AfterFunction: false + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + BeforeCatch: false + BeforeElse: false + IndentBraces: false +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Attach +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: false +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: true +ColumnLimit: 100 +CommentPragmas: '^ IWYU pragma:' +ConstructorInitializerAllOnOneLineOrOnePerLine: false +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DerivePointerAlignment: false +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +ForEachMacros: + - foreach + - Q_FOREACH + - BOOST_FOREACH +IncludeCategories: + - Regex: '^"(llvm|llvm-c|clang|clang-c)/' + Priority: 2 + - Regex: '^(<|"(gtest|gmock|isl|json)/)' + Priority: 3 + - Regex: '.*' + Priority: 1 +IncludeIsMainRegex: '(Test)?$' +IndentCaseLabels: false +IndentWidth: 2 +IndentWrappedFunctionNames: false +JavaScriptQuotes: Leave +JavaScriptWrapImports: true +KeepEmptyLinesAtTheStartOfBlocks: true +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: All +ObjCBlockIndentWidth: 2 +ObjCSpaceAfterProperty: false +ObjCSpaceBeforeProtocolList: true +PenaltyBreakBeforeFirstCallParameter: 19 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 60 +PointerAlignment: Left +ReflowComments: true +SortIncludes: true +SpaceAfterCStyleCast: false +SpaceAfterTemplateKeyword: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeParens: ControlStatements +#SpaceBeforeRangeBasedForLoopColon: true +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInContainerLiterals: true +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Cpp11 +TabWidth: 8 +UseTab: Never +... + diff --git a/.gitignore b/.gitignore index 06edde60b07e819b2d877afe567cf4256cc235a6..fc73207f3317605a0fe800ba377eb6d81b65ecc0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ # ignore patterns - +build # Auto generated files cppcheck_report.txt HallCDict.cxx @@ -14,7 +14,6 @@ THaDecDict.C THaDecDict.h haDict.h haDict.C -hcana src/HallC_LinkDef.h src/hc_compiledata.h @@ -60,3 +59,7 @@ examples/cache # Working directories work build* +build/ + +*.swp +*.swo diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000000000000000000000000000000000000..e35a1d6f4190f46a9bb6a2aa7e0a87d0513c5229 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,73 @@ +image: eicweb.phy.anl.gov:4567/whit/image_recipes/root_base:latest + +stages: + - build + - build_sing_img + - data_replays + - data_tests + +hcana_docker: + stage: build + tags: + - eic0 docker + script: + - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY + - cd containers/docker && make release + +hcana_singularity: + tags: + - singularity + stage: build_sing_img + #when: manual + dependencies: + - hcana_docker + script: + - /bin/bash .gitlabci/setup.sh + - mkdir -p build + - pwd + - cp containers/singularity/Singularity Singularity.hcana + - cp Singularity.hcana build/. + - /bin/bash .gitlabci/build.sh Singularity.hcana + - cp Singularity.hcana.simg build/. + artifacts: + paths: + - build/Singularity.hcana + - build/Singularity.hcana.simg + +elastic_replay: + when: manual + tags: + - eic0 docker + stage: data_replays + dependencies: + - hcana_singularity + script: + - bash tests/replay_elastic_data.sh + artifacts: + paths: + - ROOTfiles/* + - build/Singularity.hcana + - build/Singularity.hcana.simg + + +elastic_test1: + when: manual + tags: + - eic0 docker + stage: data_tests + dependencies: + - elastic_replay + script: + - bash tests/elastic_test.sh + +elastic_test2: + when: manual + tags: + - eic0 docker + stage: data_tests + dependencies: + - elastic_replay + script: + - bash tests/elastic_test2.sh + + diff --git a/.gitlabci/build.sh b/.gitlabci/build.sh new file mode 100644 index 0000000000000000000000000000000000000000..bd76f40e3b814ff957c6430977446855567bf15f --- /dev/null +++ b/.gitlabci/build.sh @@ -0,0 +1,175 @@ +#!/bin/bash + +# build.sh will build a Singularity container. It's not overly complicated. +# +# USAGE: build.sh --uri collection-name/container-name --cli registry Singularity +# build.sh --uri collection-name/container-name --cli registry +# build.sh Singularity + +# Copyright (C) 2017-2018 Vanessa Sochat. + +# This program is free software: you can redistribute it and/or modify it +# under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 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 Affero General Public +# License for more details. + +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <https://www.gnu.org/licenses/>. + +set -o errexit +set -o nounset + +function usage() { + + echo "USAGE: build [recipe] [options]" + echo "" + echo "OPTIONS: + + Image Format + --uri -u if uploading, a uri to give to sregistry + --cli -c the sregistry client to use (if uploading) + --help -h show this help and exit + " +} + +# --- Option processing -------------------------------------------------------- + +uri="" +cli="" +tag="" + +while true; do + case ${1:-} in + -h|--help|help) + usage + exit 0 + ;; + -u|-uri) + shift + uri="${1:-}" + shift + ;; + -t|--tag) + shift + tag="${1:-}" + shift + ;; + -c|--cli) + shift + cli="${1:-}" + shift + ;; + \?) printf "illegal option: -%s\n" "${1:-}" >&2 + usage + exit 1 + ;; + -*) + printf "illegal option: -%s\n" "${1:-}" >&2 + usage + exit 1 + ;; + *) + break; + ;; + esac +done + +################################################################################ +### Recipe File ################################################################ +################################################################################ + + +if [ $# == 0 ] ; then + recipe="Singularity" +else + recipe=$1 +fi + +echo "" +echo "Image Recipe: ${recipe}" + + +################################################################################ +### Storage Client ############################################################# +################################################################################ + +is_valid_client () { + local e match="$1" + shift + for e; do [[ "$e" == "$match" ]] && return 0; done + return 1 +} + +# Test if client is valid + +clients=("google-storage" "registry" "globus" "dropbox" "google-drive") + +if [ "${cli}" != "" ]; then + is_valid_client "${cli}" "${clients[@]}" + if [ $? -ne 0 ]; then + echo "${cli} is not a valid choice! Choose from ${clients[@]}"; + exit 1 + fi + echo "Storage Client: ${cli}" +else + echo "Storage Client: none" +fi + + +################################################################################ +### Build! ##################################################################### +################################################################################ + +# Continue if the image recipe is found + +if [ -f "$recipe" ]; then + + imagefile="${recipe}.simg" + + echo "Creating $imagefile using $recipe..." + singularity build $imagefile $recipe + + # If the image is successfully built, test it and upload (examples) + + if [ -f "${imagefile}" ]; then + + # Example testing using run (you could also use test command) + + echo "Testing the image... Marco!" + singularity exec $imagefile echo "Polo!" + + # Example sregistry commands to push to endpoints + + if [ "${cli}" != "" ]; then + + # If the uri isn't provided, he gets a robot name + if [ "${uri}" == "" ]; then + uri=$(python -c "from sregistry.logger.namer import RobotNamer; bot=RobotNamer(); print(bot.generate())") + fi + + # If a tag is provided, add to uri + if [ "${tag}" != "" ]; then + uri="${uri}:${tag}" + fi + + echo "Pushing ${uri} to ${cli}://" + echo "SREGISTRY_CLIENT=${cli} sregistry push --name ${uri} ${imagefile}" + SREGISTRY_CLIENT="${cli}" sregistry push --name "${uri}" "${imagefile}" + + else + echo "Skipping upload. Image $imagefile is finished!" + fi + + fi + +else + + echo "Singularity recipe ${recipe} not found!" + exit 1 + +fi diff --git a/.gitlabci/setup.sh b/.gitlabci/setup.sh new file mode 100644 index 0000000000000000000000000000000000000000..5c9bbe517eb1dc83dc33b142507764e10fd555d1 --- /dev/null +++ b/.gitlabci/setup.sh @@ -0,0 +1,34 @@ +#!/bin/bash + +apt-get update && apt-get install -y wget git \ + build-essential \ + squashfs-tools \ + libtool \ + autotools-dev \ + libarchive-dev \ + automake \ + autoconf \ + uuid-dev \ + python3 \ + libssl-dev + + +sed -i -e 's/^Defaults\tsecure_path.*$//' /etc/sudoers + +# Check Python +echo "Python Version:" +which python +python --version +pip install sregistry[all] +sregistry version + +echo "sregistry Version:" + +# Install Singularity + +cd /tmp && \ + git clone -b vault/release-2.5 https://www.github.com/sylabs/singularity.git + cd singularity && \ + ./autogen.sh && \ + ./configure --prefix=/usr/local && \ + make -j8 && make install diff --git a/.gitlabci/sregistry-gitlab.png b/.gitlabci/sregistry-gitlab.png new file mode 100644 index 0000000000000000000000000000000000000000..a14e917a20fb32011329af6bc6abd04012acd0d6 Binary files /dev/null and b/.gitlabci/sregistry-gitlab.png differ diff --git a/.gitlabci/sregistry-gitlab.xcf b/.gitlabci/sregistry-gitlab.xcf new file mode 100644 index 0000000000000000000000000000000000000000..f2742162bfc602f92d3d9c5cd573f29e334e042d Binary files /dev/null and b/.gitlabci/sregistry-gitlab.xcf differ diff --git a/CMakeLists.txt b/CMakeLists.txt index 815533ea222befedfb085264cc76d5cb2ed1dcb0..26e4570d9dbfbc1e6cd4680dcc87539e9b49b418 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,8 +1,31 @@ cmake_minimum_required(VERSION 3.5) -project(hcana VERSION 0.90 LANGUAGES CXX) +project(hcana VERSION 1.3.0 LANGUAGES CXX) -option(HCANA_BUILTIN_PODD "Use built-in Podd submodule (default: YES)" ON) +option(HCANA_BUILTIN_PODD "Use built-in Podd submodule (default: YES)" OFF) + +include(cmake/os.cmake) +include(FindThreads) + +find_package(ROOT 6.0 REQUIRED CONFIG) +include(${ROOT_USE_FILE}) + +#https://github.com/fmtlib/fmt.git +find_package(fmt REQUIRED) +get_target_property(FMT_INCLUDE_DIR fmt::fmt INTERFACE_INCLUDE_DIRECTORIES) +set(SPDLOG_FMT_EXTERNAL TRUE) +#add_definitions(-DSPDLOG_FMT_EXTERNAL ) +find_package(spdlog REQUIRED) +if(NOT spdlog_FOUND) + message("spdlog not found.") + message(FATAL_ERROR "spdlog should be installed with analyzer if it is not available on the system.") + #set(SPDLOG_INCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/3rd_party/spdlog/include) +else() + get_target_property(SPDLOG_INCLUDE_DIR spdlog::spdlog INTERFACE_INCLUDE_DIRECTORIES) +endif() + +find_package(EVIO REQUIRED) +get_target_property(EVIO_INCLUDE_DIR EVIO::EVIO INTERFACE_INCLUDE_DIRECTORIES) #---------------------------------------------------------------------------- # Set up Podd and ROOT dependencies @@ -12,7 +35,6 @@ if(HCANA_BUILTIN_PODD) ${CMAKE_MODULE_PATH} ) include(PoddCMakeEnv) - find_package(ROOT 5.10 REQUIRED) else() # Find Podd and register it as a dependency # This will also automatically set up ROOT @@ -22,13 +44,15 @@ else() endif() # Register ROOT dependency - it's in our public interface -config_add_dependency(ROOT 5.10) +#config_add_dependency(ROOT 5.10) #---------------------------------------------------------------------------- # Set up the compiler flags -set_compiler_flags("${ROOT_CXX_FLAGS}") -set_diagnostic_flags(WALL WEXTRA) -report_build_info() +#set_compiler_flags("${ROOT_CXX_FLAGS}") +#set_diagnostic_flags(WALL WEXTRA) +#report_build_info() + + #---------------------------------------------------------------------------- # Install in GNU-style directory layout diff --git a/README.md b/README.md index 48d0a947ff761d7a8f94d82ce840aff88e62911f..b5b741429b71e9ab592b9889a4544e7f3039fb5f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ hcana - Hall C ROOT/C++ analyzer ============================================ +Huhhh... + hcana is an under-development tool to analyze data from the HMS, SHMS and SOS spectrometers in [Hall C](http://www.jlab.org/Hall-C/) at [JLab](http://www.jlab.org/). @@ -21,8 +23,88 @@ Downloading Instructions for downloading hcana can be found in the [Hall C Wiki](https://hallcweb.jlab.org/wiki/index.php/ROOT_Analyzer/Git). +``` +wget \ +https://eicweb.phy.anl.gov/jlab/hcana/-/jobs/artifacts/master/raw/build/Singularity.hcana.simg?job=hcana_singularity \ +-O Singularity.hcana.simg +``` + Compiling --------- + +CMake is the preferred build tool. See below for builds with scons/make which +are slightly different. + +### Compiling with CMAKE + +CMake build will do a **proper** build and install. +Here we are using the install prefix `$HOME/my_exp_soft` which is like the +standard `/usr/local`. To use it make sure you your environment is setup (e.g., +towards the end of your `.bashrc`): +``` +export PATH=$HOME/my_exp_soft/bin:$PATH +export LD_LIBRARY_PATH=$HOME/my_exp_soft/lib:$HOME/my_exp_soft/lib64:$LD_LIBRARY_PATH +``` + (ノಠ益ಠ)ノ彡┻━┻ **Do not install into the source directories**. + +(ノ^_^)ノ┻━┻ ┬─┬ ノ( ^_^ノ) +First you should build evio followed by podd. Here are all the steps: + + +#### Build EVIO with cmake + +``` +git clone https://github.com/whit2333/hallac_evio.git +cd hallac_evio +mkdir build && cd build +cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/my_exp_soft +make -j4 install +``` + +#### Build analyzer (PODD) + +``` +git clone https://github.com/whit2333/analyzer.git +cd analyzer +mkdir build && cd build +cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/my_exp_soft +make -j4 install +``` + +#### Build hcana + +``` +git clone https://github.com/whit2333/hcana.git +cd hcana +mkdir build && cd build +cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/my_exp_soft +make -j4 install +``` + +All done. Now you can run `hcana` and you're off to analyze. + +#### Loading the libraries into ROOT + +``` +// .rootlogon.C +{ + gSystem->AddIncludePath(" -Iinclude/podd" ); + gSystem->AddIncludePath(" -Iinclude/hcana"); + gSystem->AddIncludePath(" -Iinclude/evio" ); + gInterpreter->AddIncludePath("include/podd" ); + gInterpreter->AddIncludePath("include/hcana"); + gInterpreter->AddIncludePath("include/evio" ); + + gSystem->Load("libevioxx.so"); + gSystem->Load("libHallA.so"); + gSystem->Load("libdc.so"); + gSystem->Load("libHallC.so"); +} +``` + + +### Other builds + hcana may be compiled with either make or scons. Switching between these two build systems make require some cleanup of dependency files, binary files and other autogenerated files. diff --git a/README_Eclipse_Linux.md b/README_Eclipse_Linux.md deleted file mode 100644 index 62c264a14a81ca2f1a1616f8eaca134b637f7ee9..0000000000000000000000000000000000000000 --- a/README_Eclipse_Linux.md +++ /dev/null @@ -1,279 +0,0 @@ -Installation of Eclipse (Kepler) on Linux (Centos6.4/RHEL), with plugins for SCons, Git, GitHub, and Python -=========================================================================================================== - -Install Eclipse ---------------- - -There exists an Eclipse plugin for SCons, called SConsolidator. As of January, 2014, this -plugin works only with the Kepler version of Eclipse. - -Most of this information can be found at: - -[Installing Eclipse on Fedora/Centos6.4/RHEL](http://www.if-not-true-then-false.com/2010/linux-install-eclipse-on-fedora-centos-red-hat-rhel/). - -To download and install this version of Eclipse, go to: - -[Eclipse Kepler SR1 Downloads](http://www.eclipse.org/downloads/packages/eclipse-ide-cc-developers/keplersr1) - -and download the Linux 64-bit version. The file should be called: - -eclipse-cpp-kepler-SR1-linux-gtk-x86_64.tar.gz - -Before you install this version of eclipse, you may have to uninstall the (older) version that -ships with Centos6.4/RHEL (The rpms may have been installed depending on what choices you made -during the system installation process). If 'which eclipse' tells you that it has been installed, -then uninstall the older version with the following series of commands: - - $ yum erase eclipse - $ yum erase eclipse-cdt - $ yum erase eclipse-rcp - $ yum erase eclipse-swt - $ yum erase jetty-eclipse - $ yum erase icu4j-eclipse - -This worked for me. You can check to see if all eclipse-related rpms have been uninstalled -with - - $ rpm -qa | grep -i eclipse - -If there are other rpms reported, you can uninstall them with commands similar to those above. - -We are going to install eclipse under /opt (of course, you can install it anywhere -you like - modify the commands below as necessary). The procedure below will -require superuser privileges. - - $ cd - $ sudo tar -xvzf ~/Downloads/eclipse-cpp-kepler-SR1-linux-gtk-x86_64.tar.gz -C /opt - $ chmod -R +r /opt/eclipse - -Now, we want to add a script to /usr/bin to launch eclipse. - - $ sudo touch /usr/bin/eclipse - $ sudo chmod 755 /usr/bin/eclipse - -With your favorite editor, create the /usr/bin/eclipse file with the following content: - - #!/bin/sh - export ECLIPSE_HOME="/opt/eclipse" - - $ECLIPSE_HOME/eclipse $* - -You may also want to create the Gnome desktop launcher for eclipse. Create the file - -/usr/share/applications/eclipse.desktop - -with the following content: - - [Desktop Entry] - Encoding=UTF-8 - Name=Eclipse - Comment=Eclipse SDK 4.3.1 - Exec=eclipse - Icon=/opt/eclipse/icon.xpm - Terminal=false - Type=Application - Categories=GNOME;Application;Development; - StartupNotify=true - -Start up Eclipse from the command line with: - - $ eclipse - -When you start up Eclipse, you will get a window asking you to choose a workspace. The -default is usually /Users/****/Documents/workspace. This is fine, but you might want to -choose someplace else. Make sure to click the "Use this as the default ..." radio button -so that you will not get asked this every time. - -When Eclipse finally starts up, you can click on the "X" on the welcome page, and it -should take you to the Project Explorer page. This is the main view that you will -probably end up using most of the time. - -Install the SConsolidator Plugin --------------------------------- - -In order for Eclipse to work with SCons, one has to install a plugin called SConsolidator. -To do this, do the following: - -a) Go to Help->Install New Software - -b) In the Install window that comes up, in the "Work with" field, enter: - -http://www.sconsolidator.com/update - -and click on "Add..." - -c) Specify the name as "SConsolidator" - -d) Check the Eclipse Plug-In for SCons radio button, then hit Next> and follow the -installation through. - -e) After the installation, Eclipse will need to be restarted, which it should do -automatically. - -When Eclipse restarts, it will ask you about setting the path to SCons. Set this up now. -Check to see where SCons is installed by doing "which scons" from a terminal window. -For me, it is in /usr/local/bin/scons, and so I entered that for the path to the SCons -executable. - -To change the SCons build options (at any time), you can go to Eclipse->Preferences, and -then expand the SCons tag, to reveal options for Build Settings, Performance vs. Accuracy, -and Warnings. In particular, if you want to build the standalone executables, you can add -'standalone=1' to the SCons Options in Build Settings. - -Install PyDev for Python Support --------------------------------- - -PyDev includes a nice Python editor with appropriate syntax highlighting, as well as -providing the "mouse-over" documentation features of Eclipse for those things that -are written in Python - namely SCons. - -As of this writing, Eclipse Kepler does not play so nicely with PyDev-3.X, and so we -will install PyDev-2.X instead. The reason may be related to issues with Java 1.6 vs. 1.7, -in fact. - -a) Go to Help->Install New Software - -b) In the Install window that comes up, in the "Work with" field, enter: - -http://pydev.org/updates - -and click on "Add..." - -c) Specify the name as "PyDev" and hit return - -d) IMPORTANT: Uncheck the radio button to show versions other than the latest version -in the bottom portion of this window. - -e) Look for the PyDev for Eclipse Version 2.8.2, and check this radio button. - -d) Proceed with the installation. - -e) IMPORTANT: At some point it may ask you to allow a certain security certificate - you -actually have to check the radio button in the top part of the window and THEN accept the -certificate. - -f) After the installation, Eclipse will need to be restarted, which it should do -automatically. - -Restart Eclipse; you should now have access to PyDev. You should see it by going to -Eclipse->About Eclipse->Installation Details->Installed Software - -Setting up Git within Eclipse ------------------------------ - -Much of this comes from [this article](http://www.vogella.com/tutorials/EclipseGit/article.html). - -a) Basic Configuration - -Select Window → Preferences → Team → Git - -Under the field for Cloning Repositories, choose a location (locally) for storing respositories that -you will eventually clone to create. - -Select Window → Preferences → Team → Git → Configuration - -Choose the User Settings Tab: - -If you have already been using git on your system, you should see that the user and email fields -are already filled out. If they are now, you can fill them out now. The 'location' field should -be ($HOME)/.gitconfig, where ($HOME) is your normal home directory - -b) Git Staging View - -Select Window → Show View → Other... → Git → Git Staging - -You should now see a Git Staging tab in the Console area of the main Eclipse window. Basically, this -window will give you all information that would be reported by 'git status' at the command line. - -c) Activate the Git Toolbar - -Select Window → Customize perspective... and check the command groups Git and Git Navigation Actions -in the Command Groups Availability tab. You should now see "Git" as one of the main pulldown menus -of the Eclipse toolbar. - -Opening hcana as a New Project from Exisiting Source within Eclipse ------------------------------------------------------------------- - -This section assumes that you have already cloned hcana (from the command line) somewhere on your system. - -a) Choose File->New->Other - -b) In the pop-up window, choose 'New SCons project from existing source', and click 'Next' - -c) Choose a project name (hcana or hcana-1.6 are good choices), specify the existing code location, and -then add any SCons Options (for example, debug=1 standalone=1 will compile the code in debug -mode, and compile the standalone codes as well. - -d) Click 'Finish' - -You should now see the project within the Project Explorer window on the RHS of the Eclipse window. -You can double-click on any file, and it should open in the editor window. You can edit and save -changes in the usual way. Clicking on the "Hammer" icon on the Eclipse toolbar should execute -scons, with the output of the build process shown in the console view at the bottom of the Eclipse -window. - -Also, you should see the current git branch that you are working on displayed next to the -top-level hcana folder that is displayed in the Project Explorer window. - -If you right-click on the hcana folder in the Project Explorer window, and then choose "Team", you -should see the various git commands available. From here, you can switch to another branch, -checkout a new branch, do commits and pushes, and/or fetch and merge from upstream. If you have -configured Eclipse to show the Git Toolbar, you can also choose a number of oft-used git commands -from the Git pulldown menu. - -Also, you can commit and push from the Git Staging window!!! And, you show the commit history -by right-clicking on the top level hcana folder, and choosing Team -> Show in History -You should see now a tab in the Console area called History, with a table of commits for the repository. - -Cloning hcana from within Eclipse --------------------------------- - -This section details how to clone your forked copy of hcana directly from within Eclipse (without -having done so at the command line already). - -a) Select File → Import → Git → Project from Git. - -b) Select Clone URI in the next dialog. - -c) Enter the URI of your repository on github, for example: - -git@github.com:brash99/hcana.git - -d) Click on ‘Next’ to get the Branch Selection dialog - -e) The default is to clone all branches. You may want to select only certain ones. Do so, -if you please, and click on ‘Next’ - -f) Choose the local destination for your cloned repository. Note that Eclipse will -warn you if there is already an existing repository clone there (which can happen as the -default is to choose your top-level directory plus the first part of the repository name, -i.e. hcana, and so this may already be used). - -g) Choose the initial branch that you want to work with. - -h) Click on ‘Next’ to get the Projects dialog. - -i) Click the ‘Use New Project wizard’ radio button, and then click on ‘Finish’ - -j) The final dialog will allow you to choose ‘New SCons project from existing source’, at -which point you can then continue from step b) in Section 5 above!! - -k) The final step is to add the appropriate Jefferson Lab reposistory as an upstream remote. - -(i) Open the Git Repositories view (Select Window → Show View → Other... → Git → Git Repositories) - -(ii) From the Git Repositories tab in the Console area, expand the repository that you are trying -to set up (hcana in this case), and then expand Remotes. You should see that origin is present. - -(iii) Right-click on Remotes, and choose 'Create Remote'. Specify the Remote Name as 'upstream'. Select -'Configure Push', and Click OK. - -(iv) Click on "Change" next to the field where one specifies the URI ... in the new dialog, specify -the remote URI as git@github.com:JeffersonLab/hcana.git. Click on 'Save'. You should now see that the -remote called upstream has been added. - -(v) The final step is to configure the upstream fetch so that it pulls from the develop branch. Expand -the upstream directory under Remotes. You will see a fetch and a push specification for the upstream -repository. The fetch specification is indicated by a left green arrow. Right-click on this, and -choose Configure Fetch. From the next dialog, choose Add. In the next dialog, for the Source, specify -the develop branch, then click Save and Finish. diff --git a/README_Eclipse_MacOSX.md b/README_Eclipse_MacOSX.md deleted file mode 100644 index 93ab9af0ba1f5425b9c23204b276b0cd0bc9f0fe..0000000000000000000000000000000000000000 --- a/README_Eclipse_MacOSX.md +++ /dev/null @@ -1,236 +0,0 @@ -Installation of Eclipse (Kepler) on MacOSX, with plugins for SCons, Git, GitHub, and Python -=========================================================================================== - -Install Eclipse ---------------- - -There exists an Eclipse plugin for SCons, called SConsolidator. As of -January, 2014, this plugin works only with the Kepler version of -Eclipse. To download and install this version of Eclipse, go to: - -[Eclipse Kepler SR1 Downloads](http://www.eclipse.org/downloads/packages/eclipse-ide-cc-developers/keplersr1) - -and download the MacOSX (Cocoa 64) version. The file should be called: - -eclipse-cpp-kepler-SR1-macosx-cocoa-x86_64.tar.gz - -Unpack this somewhere in your own user space. I chose to install it -directly underneath my home directory, but of course you can install -it where you like. - - $ cd - $ sudo tar -xvzf ~/Downloads/eclipse-cpp-kepler-SR1-macosx-cocoa-x86_64.tar.gz - -Start up Eclipse from the command line with: - - $ ~/eclipse/eclipse - -You might also find it useful to add the Eclipse app to your dock, -permanently, to make it easier to start up in the future. - -When you start up Eclipse, you will get a window asking you to choose -a workspace. The default is usually /Users/****/Documents/workspace. -This is fine, but you might want to choose someplace else. Make sure -to click the 'Use this as the default ...' radio button so that you -will not get asked this every time. - -When Eclipse finally starts up, you can click on the "X" on the -welcome page, and it should take you to the Project Explorer page. -This is the main view that you will probably end up using most of the -time. - -Install the SConsolidator Plugin --------------------------------- - -In order for Eclipse to work with SCons, one has to install a plugin -called SConsolidator. To do this, do the following: - -a) Go to Help->Install New Software - -b) In the Install window that comes up, in the "Work with" field, enter: - -http://www.sconsolidator.com/update - -and click on "Add..." - -c) Specify the name as "SConsolidator" - -d) Check the Eclipse Plug-In for SCons radio button, then hit Next> -and follow the installation through. - -e) After the installation, Eclipse will need to be restarted, which it -should do automatically. - -When Eclipse restarts, it will ask you about setting the path to -SCons. Set this up now. Check to see where SCons is installed by -doing "which scons" from a terminal window. For me, it is in -/usr/local/bin/scons, and so I entered that for the path to the SCons -executable. - -To change the SCons build options (at any time), you can go to -Eclipse->Preferences, and then expand the SCons tag, to reveal options -for Build Settings, Performance vs. Accuracy, and Warnings. In -particular, if you want to build the standalone executables, you can -add 'standalone=1' to the SCons Options in Build Settings. - -Install PyDev for Python Support --------------------------------- - -PyDev includes a nice Python editor with appropriate syntax -highlighting, as well as providing the "mouse-over" documentation -features of Eclipse for those things that are written in Python - -namely SCons. - -As of this writing, Eclipse Kepler does not play so nicely with -PyDev-3.X, and so we will install PyDev-2.X instead. The reason may -be related to issues with Java 1.6 vs. 1.7, in fact. - -a) Go to Help->Install New Software - -b) In the Install window that comes up, in the "Work with" field, enter: - -http://pydev.org/updates - -and click on "Add..." - -c) Specify the name as "PyDev" and hit return - -d) IMPORTANT: Uncheck the radio button to show versions other than the -latest version in the bottom portion of this window. - -e) Look for the PyDev for Eclipse Version 2.8.2, and check this radio button. - -d) Proceed with the installation. - -e) IMPORTANT: At some point it may ask you to allow a certain security -certificate - you actually have to check the radio button in the top -part of the window and THEN accept the certificate. - -f) After the installation, Eclipse will need to be restarted, which it -should do automatically. - -Restart Eclipse; you should now have access to PyDev. You should see -it by going to Eclipse->About Eclipse->Installation Details->Installed -Software - -Setting up Git within Eclipse ------------------------------ - -Much of this comes from [this article](http://www.vogella.com/tutorials/EclipseGit/article.html). - -a) Basic Configuration - -Select Window → Preferences → Team → Git - -Under the field for Cloning Repositories, choose a location (locally) for storing respositories that -you will eventually clone to create. - -Select Window → Preferences → Team → Git → Configuration - -Choose the User Settings Tab: - -If you have already been using git on your system, you should see that the user and email fields -are already filled out. If they are now, you can fill them out now. The 'location' field should -be ($HOME)/.gitconfig, where ($HOME) is your normal home directory - -b) Git Staging View - -Select Window → Show View → Other... → Git → Git Staging - -You should now see a Git Staging tab in the Console area of the main Eclipse window. Basically, this -window will give you all information that would be reported by 'git status' at the command line. - -c) Activate the Git Toolbar - -Select Window → Customize perspective... and check the command groups Git and Git Navigation Actions -in the Command Groups Availability tab. You should now see "Git" as one of the main pulldown menus -of the Eclipse toolbar. - -Opening hcana as a New Project from Exisiting Source within Eclipse ------------------------------------------------------------------- - -This section assumes that you have already cloned hcana (from the command line) somewhere on your system. - -a) Choose File->New->Other - -b) In the pop-up window, choose 'New SCons project from existing source', and click 'Next' - -c) Choose a project name (hcana or hcana-1.6 are good choices), specify the existing code location, and -then add any SCons Options (for example, debug=1 standalone=1 will compile the code in debug -mode, and compile the standalone codes as well. - -d) Click 'Finish' - -You should now see the project within the Project Explorer window on the RHS of the Eclipse window. -You can double-click on any file, and it should open in the editor window. You can edit and save -changes in the usual way. Clicking on the "Hammer" icon on the Eclipse toolbar should execute -scons, with the output of the build process shown in the console view at the bottom of the Eclipse -window. - -Also, you should see the current git branch that you are working on displayed next to the -top-level hcana folder that is displayed in the Project Explorer window. - -If you right-click on the hcana folder in the Project Explorer window, and then choose "Team", you -should see the various git commands available. From here, you can switch to another branch, -checkout a new branch, do commits and pushes, and/or fetch and merge from upstream. If you have -configured Eclipse to show the Git Toolbar, you can also choose a number of oft-used git commands -from the Git pulldown menu. - -Also, you can commit and push from the Git Staging window!!! And, you show the commit history -by right-clicking on the top level hcana folder, and choosing Team -> Show in History -You should see now a tab in the Console area called History, with a table of commits for the repository. - -Cloning hcana from within Eclipse --------------------------------- - -This section details how to clone your forked copy of hcana directly from within Eclipse (without -having done so at the command line already). - -a) Select File → Import → Git → Project from Git. - -b) Select Clone URI in the next dialog. - -c) Enter the URI of your repository on github, for example: - -git@github.com:brash99/hcana.git - -d) Click on ‘Next’ to get the Branch Selection dialog - -e) The default is to clone all branches. You may want to select only certain ones. Do so, -if you please, and click on ‘Next’ - -f) Choose the local destination for your cloned repository. Note that Eclipse will -warn you if there is already an existing repository clone there (which can happen as the -default is to choose your top-level directory plus the first part of the repository name, -i.e. hcana, and so this may already be used). - -g) Choose the initial branch that you want to work with. - -h) IMPORTANT!!!! Click the radio button to Clone Submodules!!!! - -i) Click on ‘Next’ to get the Projects dialog. - -j) Click the ‘Use New Project wizard’ radio button, and then click on ‘Finish’ - -k) The final dialog will allow you to choose ‘New SCons project from existing source’, at -which point you can then continue from step b) in Section 5 above!! - -l) The final step is to add the appropriate Jefferson Lab reposistory as an upstream remote. - -(i) Open the Git Repositories view (Select Window → Show View → Other... → Git → Git Repositories) - -(ii) From the Git Repositories tab in the Console area, expand the repository that you are trying -to set up (hcana in this case), and then expand Remotes. You should see that origin is present. - -(iii) Right-click on Remotes, and choose 'Create Remote'. Specify the Remote Name as 'upstream'. Select -'Configure Push', and Click OK. - -(iv) Click on "Change" next to the field where one specifies the URI ... in the new dialog, specify -the remote URI as git@github.com:JeffersonLab/hcana.git. Click on 'Save'. You should now see that the -remote called upstream has been added. - -(v) The final step is to configure the upstream fetch so that it pulls from the develop branch. Expand -the upstream directory under Remotes. You will see a fetch and a push specification for the upstream -repository. The fetch specification is indicated by a left green arrow. Right-click on this, and -choose Configure Fetch. From the next dialog, choose Add. In the next dialog, for the Source, specify -the develop branch, then click Save and Finish. diff --git a/README_evio.md b/README_evio.md deleted file mode 100644 index b3fd5c8826b267357785c1b51a7e58aec20a322f..0000000000000000000000000000000000000000 --- a/README_evio.md +++ /dev/null @@ -1,67 +0,0 @@ -hcana with externally built evio libraries -============================================ - -As of PODD version 1.6, EVIO is built as an external library from the official JLAB -DAQ group source code. As of this writing, the official release is version 4.4.5. -In order to compile hcana with PODD version 1.6, one must download, install, and define -appropriate environment variables for the evio libraries. - -Downloading ------------ - -On your local system, retrieve and unpack the EVIO source distribution: - - $ wget --no-check-certificate https://coda.jlab.org/drupal/system/files/coda/evio/evio-4.4/evio-4.4.5.tgz - $ tar -xvzf evio-4.4.5.tgz - $ cd evio-4.4.5 - -This will unpack the EVIO source code in a directory called evio-4.4.5, and take you -into that new directory. - -Compiling ---------- - -You can now compile the EVIO libraries with: - - $ scons - $ scons install --prefix=. - -This will install the libaries in a subdirectory of the current source directory according to the operating system that you are using. - -Environment ------------ - -The final step is to define the environment variables necessary to tell hcana where your EVIO libraries are installed. I include here excerpts from a my .cshrc file on the JLab systems (where the SHELL is tcsh), and also from my .bash_profile file on a Mac OS X system (where the SHELL is bash). This should give you enough of a guide to be able to modify your environment variable definition appropriately. - -.cshrc - - setenv HCANALYZER /home/brash/analysis/hcana - setenv ANALYZER /home/brash/analysis/hcana/podd - setenv INSTALL_DIR /home/brash/evio-4.4.5 - setenv KERNEL_NAME `uname -s` - setenv MACHINE_NAME `uname -m` - setenv EVIO_SUBDIR $KERNEL_NAME-$MACHINE_NAME - setenv EVIO_BINDIR $INSTALL_DIR/$EVIO_SUBDIR/bin - setenv EVIO_LIBDIR $INSTALL_DIR/$EVIO_SUBDIR/lib - setenv EVIO_INCDIR $INSTALL_DIR/$EVIO_SUBDIR/include - setenv LD_LIBRARY_PATH "${HCANALYZER}:${ANALYZER}/src:${ANALYZER}/hana_decode:${ANALYZER}/hana_scaler:${EVIO_LIBDIR}:${ANALYZER}" - setenv DB_DIR $ANALYZER/DB - set path = ( $ANALYZER/bin $HCANALYZER/bin $EVIO_BINDIR $path ) - -.bash_profile - - export HCANALYZER=/Users/brash/Dropbox/Research/analysis/hcana - export ANALYZER=/Users/brash/Dropbox/Research/analysis/hcana/podd - export INSTALL_DIR=/Users/brash/Dropbox/Research/analyzer-evio/evio-4.4.5 - export KERNEL_NAME=`uname -s` - export MACHINE_NAME=`uname -m` - export EVIO_SUBDIR=$KERNEL_NAME-$MACHINE_NAME - export EVIO_BINDIR=$INSTALL_DIR/$EVIO_SUBDIR/bin - export EVIO_LIBDIR=$INSTALL_DIR/$EVIO_SUBDIR/lib - export EVIO_INCDIR=$INSTALL_DIR/$EVIO_SUBDIR/include - export PATH=$HCANALYZER/bin:$ANALYZER/bin:$EVIO_BINDIR:$PATH - export DYLD_LIBRARY_PATH=$HCANALYZER:$ANALYZER:$EVIO_LIBDIR:$DYLD_LIBRARY_PATH - export LD_LIBRARY_PATH=$HCANALYZER:$ANALYZER:$EVIO_LIBDIR:$LD_LIBRARY_PATH - - - diff --git a/SConscript.py b/SConscript.py deleted file mode 100644 index c8f4ccd2eb1bcf9a15947594684d152be4f15c1c..0000000000000000000000000000000000000000 --- a/SConscript.py +++ /dev/null @@ -1,120 +0,0 @@ -###### Hall C Software Main SConscript File ##### -###### Author: Edward Brash (brash@jlab.org) June 2013 - -import os -import re -import sys -import subprocess -import platform -import time -import SCons.Util -Import ('pbaseenv') - -######## ROOT Dictionaries ######### - -roothcdict = pbaseenv.subst('$HC_DIR')+'/HallCDict.C' -roothcobj = pbaseenv.subst('$HC_SRC')+'/HallCDict.so' - -hcheadersbase = Glob('src/*.h',exclude=['src/THcGlobals.h','src/HallC_LinkDef.h']) - -cmd = "cat src/HallC_LinkDef.h_preamble > src/HallC_LinkDef.h" -os.system(cmd) - -for hcheaderfile in hcheadersbase: - filename = '%s' % hcheaderfile - basefilename = filename.rsplit('.',1) - newbasefilename = basefilename[0].rsplit('/',1) - # Assume filenames beginning with Scaler are decoder classes - if newbasefilename[1] == 'hc_compiledata': - continue - if newbasefilename[1][:6] == 'Scaler' or newbasefilename[1] == "TIBlobModule": - cmd1 = "echo '#pragma link C++ class Decoder::%s+;' >> src/HallC_LinkDef.h" % newbasefilename[1] - else: - cmd1 = "echo '#pragma link C++ class %s+;' >> src/HallC_LinkDef.h" % newbasefilename[1] - os.system(cmd1) - -cmd = "cat src/HallC_LinkDef.h_postamble >> src/HallC_LinkDef.h" -os.system(cmd) - -hcheaders = Glob('src/*.h',exclude=['src/HallC_LinkDef.h','src/hc_compiledata.h'])+Glob('src/HallC_LinkDef.h') - -pbaseenv.RootCint(roothcdict,hcheaders) -pbaseenv.Clean(roothcdict,re.sub(r'\.C\Z','_rdict.pcm',roothcdict)) -pbaseenv.SharedObject(target = roothcobj, source = roothcdict) - -####### write src/hc_compiledata.h header file ###### - -if sys.version_info >= (2, 7): - try: - cmd = "git rev-parse HEAD 2>/dev/null" - gitrev = subprocess.check_output(cmd, shell=True).rstrip() - except: - gitrev = '' - try: - cmd = pbaseenv.subst('$CXX') + " --version 2>/dev/null | head -1" - cxxver = subprocess.check_output(cmd, shell=True).rstrip() - except: - cxxver = '' - # subprocess gives us byte string literals in Python 3, but we'd like - # Unicode strings - if sys.version_info >= (3, 0): - gitrev = gitrev.decode() - cxxver = cxxver.decode() -else: - FNULL = open(os.devnull, 'w') - try: - gitrev = subprocess.Popen(['git', 'rev-parse', 'HEAD', '2>dev/null'],\ - stdout=subprocess.PIPE, stderr=FNULL).communicate()[0].rstrip() - except: - gitrev ='' - try: - outp = subprocess.Popen([pbaseenv.subst('$CXX'), '--version'],\ - stdout=subprocess.PIPE, stderr=FNULL).communicate()[0] - lines = outp.splitlines() - cxxver = lines[0] - except: - cxxver = '' - -compiledata = 'src/hc_compiledata.h' -f=open(compiledata,'w') -f.write('#ifndef HCANA_COMPILEDATA_H\n') -f.write('#define HCANA_COMPILEDATA_H\n') -f.write('\n') -f.write('#define HC_INCLUDEPATH "%s"\n' % (pbaseenv.subst('$HC_SRC'))) -f.write('#define HC_VERSION "%s"\n' % pbaseenv.subst('$HC_VERSION')) -f.write('#define HC_DATE "%s"\n' % time.strftime("%b %d %Y")) -f.write('#define HC_DATETIME "%s"\n' % time.strftime("%a %b %d %Y")) -#f.write('#define HC_DATETIME "%s"\n' % time.strftime("%a %b %d %H:%M:%S %Z %Y")) -f.write('#define HC_PLATFORM "%s"\n' % platform.platform()) -f.write('#define HC_BUILDNODE "%s"\n' % platform.node()) -f.write('#define HC_BUILDDIR "%s"\n' % os.getcwd()) -try: - builduser = pbaseenv['ENV']['LOGNAME'] -except: - builduser = '' -f.write('#define HC_BUILDUSER "%s"\n' % builduser) -f.write('#define HC_GITVERS "%s"\n' % gitrev[:7]) -f.write('#define HC_CXXVERS "%s"\n' % cxxver) -f.write('#define HC_ROOTVERS "%s"\n' % pbaseenv.subst('$ROOTVERS')) -f.write('#define HCANA_VERSION_CODE %s\n' % pbaseenv.subst('$VERCODE')) -f.write('#define HCANA_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))\n') -f.write('\n') -f.write('#endif\n') -f.close() - -####### Start of main SConscript ########### - -print ('LIBS = %s\n' % pbaseenv.subst('$LIBS')) - -# SCons seems to ignore $RPATH on macOS... sigh -if pbaseenv['PLATFORM'] == 'darwin': - try: - for rp in pbaseenv['RPATH']: - pbaseenv.Append(LINKFLAGS = ['-Wl,-rpath,'+rp]) - except KeyError: - pass - -analyzer = pbaseenv.Program(target = 'hcana', source = 'src/main.o') -pbaseenv.Install('./bin',analyzer) -pbaseenv.Alias('install',['./bin']) -#pbaseenv.Clean(analyzer,) diff --git a/SConstruct b/SConstruct deleted file mode 100644 index d5651fe480d86023c153c110bbdeeefa785c5c79..0000000000000000000000000000000000000000 --- a/SConstruct +++ /dev/null @@ -1,137 +0,0 @@ -#!/usr/bin/env python -###### Hall C Software Main SConstruct Build File ##### -###### Author: Edward Brash (brash@jlab.org) June 2013 - -import os -import sys -#import platform -#import commands -import SCons -import subprocess - -####### Check SCons version ################## -print('!!! Building the Hall C analyzer and libraries with SCons requires') -print('!!! SCons version 2.5.0 or newer.') -EnsureSConsVersion(2,5,0) - -baseenv = Environment(ENV = os.environ,tools=["default","rootcint"],toolpath=['podd/site_scons']) - -####### Hall A Build Environment ############# -# -baseenv.Append(HEAD_DIR= Dir('.').abspath) -baseenv.Append(HC_DIR= baseenv.subst('$HEAD_DIR')) -baseenv.Append(HC_SRC= baseenv.subst('$HC_DIR')+'/src') -baseenv.Append(HA_DIR= baseenv.subst('$HC_DIR')+'/podd') -baseenv.Append(MAIN_DIR= baseenv.subst('$HEAD_DIR')) -baseenv.Append(HA_Podd = os.path.join(baseenv.subst('$HA_DIR'),'Podd')) -baseenv.Append(HA_DC = os.path.join(baseenv.subst('$HA_DIR'),'hana_decode')) -baseenv.Append(MAJORVERSION = '0') -baseenv.Append(MINORVERSION = '90') -baseenv.Append(PATCH = '0') -baseenv.Append(SOVERSION = baseenv.subst('$MAJORVERSION')+'.'+baseenv.subst('$MINORVERSION')) -baseenv.Append(VERSION = baseenv.subst('$SOVERSION')+'.'+baseenv.subst('$PATCH')) -baseenv.Append(EXTVERS = '') -baseenv.Append(HC_VERSION = baseenv.subst('$VERSION')+baseenv.subst('$EXTVERS')) -print ("Hall C Main Directory = %s" % baseenv.subst('$HC_DIR')) -print ("Hall C Source Directory = %s" % baseenv.subst('$HC_SRC')) -print ("Hall A Main Directory = %s" % baseenv.subst('$HA_DIR')) -print ("Software Version = %s" % baseenv.subst('$VERSION')) -ivercode = 65536*int(float(baseenv.subst('$SOVERSION')))+ 256*int(10*(float(baseenv.subst('$SOVERSION'))-int(float(baseenv.subst('$SOVERSION')))))+ int(float(baseenv.subst('$PATCH'))) -baseenv.Append(VERCODE = ivercode) -baseenv.Append(CPPPATH = ['$HC_SRC','$HA_Podd','$HA_DC']) - -sys.path.insert(1,baseenv.subst('$HA_DIR'+'/site_scons')) -import configure - -configure.FindROOT(baseenv) - -######## cppcheck ########################### - -proceed = "1" or "y" or "yes" or "Yes" or "Y" -if baseenv.subst('$CPPCHECK')==proceed: - is_cppcheck = which('cppcheck') - print ("Path to cppcheck is %s\n" % is_cppcheck) - - if(is_cppcheck == None): - print('!!! cppcheck not found on this system. Check if cppcheck is installed and in your PATH.') - Exit(1) - else: - cppcheck_command = baseenv.Command('cppcheck_report.txt',[],"cppcheck --quiet --enable=all src/ 2> $TARGET") - baseenv.AlwaysBuild(cppcheck_command) - -######## Configure Section ####### - -if not (baseenv.GetOption('clean') or baseenv.GetOption('help')): - - configure.config(baseenv,ARGUMENTS) - - conf = Configure(baseenv) - if not conf.CheckCXX(): - print('!!! Your compiler and/or environment is not correctly configured.') - Exit(1) - # if not conf.CheckFunc('printf'): - # print('!!! Your compiler and/or environment is not correctly configured.') - # Exit(1) - if conf.CheckCXXHeader('sstream'): - conf.env.Append(CPPDEFINES = 'HAS_SSTREAM') - baseenv = conf.Finish() - -Export('baseenv') - -#print (baseenv.Dump()) -#print ('CXXFLAGS = ', baseenv['CXXFLAGS']) -#print ('LINKFLAGS = ', baseenv['LINKFLAGS']) -#print ('SHLINKFLAGS = ', baseenv['SHLINKFLAGS']) - -####### Start of main SConstruct ############ - -hallclib = 'HallC' -poddlib = 'Podd' -dclib = 'dc' - -baseenv.Append(LIBPATH=['$HC_DIR','$HC_SRC','$HA_Podd','$HA_DC']) -baseenv.Append(RPATH=['$HC_DIR','$HA_Podd','$HA_DC']) -baseenv.Replace(SHLIBSUFFIX = '.so') -baseenv.Replace(SOSUFFIX = baseenv.subst('$SHLIBSUFFIX')) -#baseenv.Replace(SHLIBSUFFIX = '.so') -baseenv.Append(SHLIBSUFFIX = '.'+baseenv.subst('$VERSION')) - -pbaseenv=baseenv.Clone() -pbaseenv.Prepend(LIBS=[hallclib,poddlib,dclib]) -baseenv.Prepend(LIBS=[poddlib,dclib]) -Export('pbaseenv') - -if pbaseenv['CXX'] == 'g++': - gxxVersion = [int(i) for i in pbaseenv['CXXVERSION'].split('.')] - if (gxxVersion[0] < 4) or (gxxVersion[0] == 4 and gxxVersion[1] < 4): - print('Error: g++ version too old! Need at least g++ 4.4!') - Exit(1) - -##directorylist = ['./','src','podd','podd/src','podd/hana_decode'] -##SConscript('podd/SConstruct') - -if baseenv.GetOption('clean'): - subprocess.call(['echo', '!!!!!! Cleaning Podd Directory !!!!!! ']) - podd_command_scons = "cd %s; scons -c" % baseenv.subst('$HA_DIR') -else: - subprocess.call(['echo', '!!!!!! Building Podd !!!!!! ']) - podd_command_scons = "cd %s; scons" % baseenv.subst('$HA_DIR') - if baseenv.GetOption('num_jobs'): - podd_command_scons += " -j%s" % (GetOption('num_jobs')) - if baseenv.GetOption('silent'): - podd_command_scons += " -s" - for key,value in ARGLIST: - podd_command_scons += " %s=%s" % (key,value) - -print ("podd_command_scons = %s" % podd_command_scons) - -os.system(podd_command_scons) - -directorylist = ['./','src'] -SConscript(dirs = directorylist,name='SConscript.py',exports='baseenv') - -####### End of SConstruct ######### - -# Local Variables: -# mode: python -# End: diff --git a/cmake/hcanaConfig.cmake.in b/cmake/hcanaConfig.cmake.in index e476f962b439585941fd58a79cb9fdc3711bf559..480c7a12cbe837ce8d9cb407337df67bfa1bb0d0 100644 --- a/cmake/hcanaConfig.cmake.in +++ b/cmake/hcanaConfig.cmake.in @@ -9,9 +9,16 @@ if(IS_DIRECTORY "@PACKAGE_INSTALL_CONFIGDIR@/Modules") list(APPEND CMAKE_MODULE_PATH "@PACKAGE_INSTALL_CONFIGDIR@/Modules") endif() -@FIND_DEPENDENCY_COMMANDS@ - include("@PACKAGE_TARGETS_FILE@") +@FIND_DEPENDENCY_COMMANDS@ + check_required_components(@PROJECT_NAME_UC@) +## Extra rpath stuff for MacOS +if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin") + set(CMAKE_INSTALL_RPATH + ${CMAKE_INSTALL_RPATH} + "@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_LIBDIR@") + message("hcana: set rpath to ${CMAKE_INSTALL_RPATH}") +endif() diff --git a/cmake/modules/CompileTimeInfo.cmake b/cmake/modules/CompileTimeInfo.cmake new file mode 100644 index 0000000000000000000000000000000000000000..3b181c05fc5b3d2b69df6ba5f8a14d7b324c912f --- /dev/null +++ b/cmake/modules/CompileTimeInfo.cmake @@ -0,0 +1,67 @@ +cmake_minimum_required(VERSION 2.8) + +# Return the date (yyyy-mm-dd) +macro(DATE RESULT) + if(WIN32) + execute_process(COMMAND "cmd" " /C date /T" OUTPUT_VARIABLE ${RESULT}) + string(REGEX REPLACE "(..)/(..)/(....).*" "\\3-\\2-\\1" ${RESULT} ${${RESULT}}) + elseif(UNIX) + execute_process(COMMAND "date" "+%Y-%m-%d" OUTPUT_VARIABLE ${RESULT}) + else() + message(SEND_ERROR "Unable to detect date") + set(${RESULT} UNKNOWN) + endif() +endmacro() + +# Return the time (hh:mm:ss) +macro(TIME RESULT) + if(WIN32) + execute_process(COMMAND "cmd" " /C echo %TIME%" OUTPUT_VARIABLE ${RESULT}) + string(REGEX REPLACE "(..:..:..),(..)" "\\1" ${RESULT} ${${RESULT}}) + elseif(UNIX) + execute_process(COMMAND "date" "+%H:%M:%S" OUTPUT_VARIABLE ${RESULT}) + else() + message(SEND_ERROR "Unable to detect time") + set(${RESULT} UNKNOWN) + endif() +endmacro() + + +execute_process(COMMAND "date" "+%b:%d:%Y" + OUTPUT_VARIABLE HCANA_BUILD_DATE + OUTPUT_STRIP_TRAILING_WHITESPACE) + +execute_process(COMMAND "date" "+%a %b %d %H:%M:%S %Z %Y" + OUTPUT_VARIABLE HCANA_BUILD_DATETIME + OUTPUT_STRIP_TRAILING_WHITESPACE) + +execute_process(COMMAND "bash" "-c" "echo $(uname -s)-$(uname -r)-$(uname -m)" + OUTPUT_VARIABLE HCANA_PLATFORM + OUTPUT_STRIP_TRAILING_WHITESPACE) + +execute_process(COMMAND "uname" "-n" + OUTPUT_VARIABLE HCANA_NODE + OUTPUT_STRIP_TRAILING_WHITESPACE) +execute_process(COMMAND "pwd" + OUTPUT_VARIABLE HCANA_BUILD_DIR + OUTPUT_STRIP_TRAILING_WHITESPACE) +execute_process(COMMAND "whoami" + OUTPUT_VARIABLE HCANA_BUILD_USER + OUTPUT_STRIP_TRAILING_WHITESPACE) + +execute_process(COMMAND "bash" "-c" "echo $(git rev-parse HEAD 2>/dev/null | cut -c1-7)" + OUTPUT_VARIABLE HCANA_GIT_VERSION + OUTPUT_STRIP_TRAILING_WHITESPACE) + +execute_process(COMMAND "bash" "-c" "echo $(${CMAKE_CXX_COMPILER} --version 2>/dev/null | head -1)" + OUTPUT_VARIABLE HCANA_CXX_VERSION + OUTPUT_STRIP_TRAILING_WHITESPACE) + +execute_process(COMMAND "bash" "-c" "echo $(root-config --version)" + OUTPUT_VARIABLE HCANA_ROOT_VERSION + OUTPUT_STRIP_TRAILING_WHITESPACE) + +execute_process(COMMAND "bash" "-c" "printf '%02d%02d%02d' ${PROJECT_VERSION_MAJOR} ${PROJECT_VERSION_MINOR} ${PROJECT_VERSION_PATCH}" + OUTPUT_VARIABLE HCANA_VERCODE + OUTPUT_STRIP_TRAILING_WHITESPACE) + diff --git a/cmake/modules/FindLZ4.cmake b/cmake/modules/FindLZ4.cmake new file mode 100644 index 0000000000000000000000000000000000000000..4658a35bfa1af203da324982aa78eb53c411e409 --- /dev/null +++ b/cmake/modules/FindLZ4.cmake @@ -0,0 +1,39 @@ +# Finds liblz4. +# +# This module defines: +# LZ4_FOUND +# LZ4_INCLUDE_DIR +# LZ4_LIBRARY +# + +find_path(LZ4_INCLUDE_DIR NAMES lz4.h) +find_library(LZ4_LIBRARY NAMES lz4) + +# We require LZ4_compress_default() which was added in v1.7.0 +if (LZ4_LIBRARY) + include(CheckCSourceRuns) + set(CMAKE_REQUIRED_INCLUDES ${LZ4_INCLUDE_DIR}) + set(CMAKE_REQUIRED_LIBRARIES ${LZ4_LIBRARY}) + check_c_source_runs(" +#include <lz4.h> +int main() { + int good = (LZ4_VERSION_MAJOR > 1) || + ((LZ4_VERSION_MAJOR == 1) && (LZ4_VERSION_MINOR >= 7)); +return !good; +}" LZ4_GOOD_VERSION) + set(CMAKE_REQUIRED_INCLUDES) + set(CMAKE_REQUIRED_LIBRARIES) +endif() + +include(FindPackageHandleStandardArgs) +FIND_PACKAGE_HANDLE_STANDARD_ARGS( + LZ4 DEFAULT_MSG + LZ4_LIBRARY LZ4_INCLUDE_DIR LZ4_GOOD_VERSION) + +if (NOT LZ4_FOUND) + message(STATUS "Using third-party bundled LZ4") +else() + message(STATUS "Found LZ4: ${LZ4_LIBRARY}") +endif (NOT LZ4_FOUND) + +mark_as_advanced(LZ4_INCLUDE_DIR LZ4_LIBRARY) diff --git a/cmake/os.cmake b/cmake/os.cmake new file mode 100644 index 0000000000000000000000000000000000000000..2e8c979774a88056ece491d0ba5aee7c64a59d62 --- /dev/null +++ b/cmake/os.cmake @@ -0,0 +1,8 @@ +## Set correct rpath on MacOs +if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin") + set(CMAKE_MACOSX_RPATH 1) + set(CMAKE_INSTALL_RPATH + ${CMAKE_INSTALL_RPATH} + "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}") +message("Setting RPath to ${CMAKE_INSTALL_RPATH}") +endif() diff --git a/cmake/root.cmake b/cmake/root.cmake new file mode 100644 index 0000000000000000000000000000000000000000..e64cbaa8cba8af5cc1f53f7420db21bf0b2304e2 --- /dev/null +++ b/cmake/root.cmake @@ -0,0 +1,20 @@ +## Override root's ROOT_GENERATE_DICTIONARY macro to be less error-prone. This +## is done by only allowing for explicitly speficied header locations/include +## directories, instead of using the full search path for this module. +function(ROOT_GENERATE_DICTIONARY dictionary) + CMAKE_PARSE_ARGUMENTS(ARG "" "" "INCLUDEDIRS;LINKDEF;OPTIONS" "" ${ARGN}) + ## Get all include directories + get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES) + set(dirs ${dirs} ${ARG_INCLUDEDIRS}) + set(extra_includes "") + foreach(dir ${dirs}) + set(extra_includes ${extra_includes} "-I${dir}") + endforeach() + ## find and call ROOTCLING + find_program(ROOTCLING rootcling) + add_custom_command( + OUTPUT ${dictionary}.cxx ${dictionary}_rdict.pcm + COMMAND ${ROOTCLING} -f ${dictionary}.cxx -s ${dictionary}.pcm + ${ARG_OPTIONS} ${extra_includes} ${ARG_UNPARSED_ARGUMENTS} ${ARG_LINKDEF} + DEPENDS ${includes} ${linkdefs}) +endfunction() diff --git a/containers/docker/Dockerfile b/containers/docker/Dockerfile new file mode 100644 index 0000000000000000000000000000000000000000..a11d5c0a5c2687b65425d81bd15bc6a1e7964da6 --- /dev/null +++ b/containers/docker/Dockerfile @@ -0,0 +1,51 @@ +FROM eicweb.phy.anl.gov:4567/containers/image_recipes/root_base:latest + +LABEL maintainer "Whitney Armstrong <warmstrong@anl.gov>" +# + +RUN ls -lrth /usr/local/lib/lib*.so \ + && export PYTHONPATH=/usr/local/lib:$PYTHONPATH \ + && export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH \ + && export PATH=/usr/local/bin:$PATH \ + && source /usr/local/bin/thisroot.sh \ + && cd /tmp \ + && git clone https://github.com/fmtlib/fmt.git && cd fmt \ + && git checkout 5.3.0 && mkdir /tmp/build && cd /tmp/build \ + && cmake -DBUILD_SHARED_LIBS=TRUE ../fmt \ + && make -j20 install \ + && cd /tmp && rm -r /tmp/build && rm -r /tmp/fmt \ + && cd /tmp \ + && git clone https://eicweb.phy.anl.gov/jlab/hallc/analyzer_software/hallac_evio.git \ + && mkdir hallac_evio/build && cd hallac_evio/build \ + && cmake ../. && make -j20 && make install \ + && cd /tmp && rm -rf hallac_evio \ + && cd /tmp \ + && export PYTHONPATH=/usr/local/lib:$PYTHONPATH \ + && export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH \ + && export PATH=/usr/local/bin:$PATH \ + && git clone https://eicweb.phy.anl.gov/jlab/hallc/analyzer_software/analyzer.git \ + && mkdir analyzer/build && cd analyzer/build && git pull && git checkout master\ + && cmake ../. && make -j20 VERBOSE=1 && make install \ + && cd /tmp && rm -rf analyzer + +RUN cd /tmp \ + && git clone https://eicweb.phy.anl.gov/jlab/hallc/analyzer_software/hcana.git \ + && mkdir hcana/build && cd hcana/build \ + && git pull \ + && cmake ../. && make -j20 && make install \ + && cd /tmp && rm -rf hcana + + +#-DCMAKE_CXX_FLAGS=" -march=haswell -O3 -mfma -malign-data=cacheline -finline-functions " +#&& wget -O- https://root.cern.ch/download/root_v6.14.06.source.tar.gz | tar -zxvf - \ +#&& mv root-6.14.06 root_master \ +#RUN which c++ && ls -lrth /usr/bin/c++ && cd /tmp/builds/root_build && make -j38 VERBOSE=1 && make install \ +# && cd /tmp && rm -rf /tmp/root_master && rm -rf /tmp/builds/root_build + +#RUN useradd -ms /bin/bash -d /opt/user user +#USER user +#WORKDIR /opt/bubble_user + +##CMD ["-c" ] +#ENTRYPOINT ["/bin/bash"] + diff --git a/containers/docker/Dockerfile.broadwell b/containers/docker/Dockerfile.broadwell new file mode 100644 index 0000000000000000000000000000000000000000..9185d4528387f17217baf733244bdc6bf2e03a54 --- /dev/null +++ b/containers/docker/Dockerfile.broadwell @@ -0,0 +1,58 @@ +# ROOT base +# +# A container for the latest root +# +FROM whit/image_recipes/ubuntu_base:latest +LABEL maintainer "Whitney Armstrong <warmstrong@anl.gov>" +# + +RUN cd /tmp \ + && wget http://bitbucket.org/eigen/eigen/get/3.3.4.tar.bz2 \ + && tar -xvf 3.3.4.tar.bz2 \ + && cd eigen-* \ + && mkdir build && cd build \ + && cmake ../. -DCMAKE_CXX_FLAGS=" -march=haswell -O3 -mfma -malign-data=cacheline -finline-functions " \ + && make -j10 > /tmp/eigen_build.log && make install + +RUN cd /tmp \ + && git clone --depth=1 https://gitlab.cern.ch/CLHEP/CLHEP.git \ + && mkdir -p builds/clhep_build \ + && cd builds/clhep_build \ + && cmake /tmp/CLHEP/. -DCMAKE_CXX_FLAGS=" -march=haswell -O3 -mfma -malign-data=cacheline -finline-functions "\ + && make -j38 install > /tmp/clhep_build.log \ + && cd /tmp && rm -rf /tmp/CLHEP && rm -rf /tmp/builds/clhep_build + +RUN cd /tmp \ +&& git clone https://github.com/VcDevel/Vc.git \ +&& cd Vc \ +&& git submodule update --init \ +&& mkdir build && cd build \ +&& cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DBUILD_TESTING=OFF -DTARGET_ARCHITECTURE=broadwell ../. \ +&& make -j30 > /tmp/vc_build.log \ +&& make install + +# Build root from the repo master +RUN cd /tmp \ + && pwd \ + && git clone --depth=1 https://github.com/root-project/root.git root_master \ + && cd /tmp && mkdir -p builds/root_build \ + && cd builds/root_build \ + && cmake ../../root_master/. -Droot7:BOOL=ON -Dcxx17:BOOL=ON -Dfortran:BOOL=ON \ + -Dgdml:BOOL=ON -Dmathmore:BOOL=ON -Dminuit2:BOOL=ON -Dbuiltin_vdt:BOOL=ON -Dbuiltin_veccore:BOOL=ON \ + -Dvc:BOOL=ON -Dbuiltin_vecgeom:BOOL=ON -Dunuran:BOOL=ON \ + && cd /tmp/builds/root_build && make -j38 > /tmp/root_build.log && make install \ + && cd /tmp && rm -rf /tmp/root_master && rm -rf /tmp/builds/root_build + +#-DCMAKE_CXX_FLAGS=" -march=haswell -O3 -mfma -malign-data=cacheline -finline-functions " +#&& wget -O- https://root.cern.ch/download/root_v6.14.06.source.tar.gz | tar -zxvf - \ +#&& mv root-6.14.06 root_master \ +#RUN which c++ && ls -lrth /usr/bin/c++ && cd /tmp/builds/root_build && make -j38 VERBOSE=1 && make install \ +# && cd /tmp && rm -rf /tmp/root_master && rm -rf /tmp/builds/root_build + +#RUN useradd -ms /bin/bash -d /opt/user user +#USER user +#WORKDIR /opt/bubble_user + +##CMD ["-c" ] +#ENTRYPOINT ["/bin/bash"] + diff --git a/containers/docker/Makefile b/containers/docker/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..9e94fa8d988907fbc7e569fde0270b6717810549 --- /dev/null +++ b/containers/docker/Makefile @@ -0,0 +1,208 @@ +# import config. +# You can change the default config with `make cnf="config_special.env" build` +cnf ?= config.env +include $(cnf) +# exports variables in config.env as environment variables +export $(shell sed 's/=.*//' $(cnf)) + + +# import deploy config +# You can change the default deploy config with `make cnf="deploy_special.env" release` +dpl ?= deploy.env +include $(dpl) +export $(shell sed 's/=.*//' $(dpl)) + +# grep the version from the mix file +VERSION=$(shell bash version.sh) + +# help will output the help for each task +# thanks to https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html +.PHONY: help + +help: ## This help. + @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) + +.DEFAULT_GOAL := help + +# ========================================================================== +# +build: ## build the image + docker build -t $(APP_NAME) . + +build-nc: ## Build the container without caching (from scratch) + docker build --no-cache -t $(APP_NAME) . + +build-alt: ## build the container for various machine architectures (broadwell, haswell, knl) + @echo 'building for architecture: $(ALT_NAME)' + docker build -t $(APP_NAME)_$(ALT_NAME) -f Dockerfile.$(ALT_NAME) . + +build-alt-nc: ## build the container for various machine architectures (broadwell, haswell, knl) + @echo 'build-alt-nc: building for architecture: $(ALT_NAME)' + docker build --no-cache -t $(APP_NAME)_$(ALT_NAME) -f Dockerfile.$(ALT_NAME) . + +# ========================================================================== +# +run: ## Run container on port configured in `config.env` + docker run -i -t --rm --env-file=./config.env -p=$(PORT):$(PORT) --name="$(APP_NAME)" $(REPO)/$(APP_NAME):$(TAG_VERSION) + +up: build run ## Run container on port configured in `config.env` (Alias to run) + +stop: ## Stop and remove a running container + docker stop $(APP_NAME); docker rm $(APP_NAME) + +# ========================================================================== +# Docker tagging +tag: tag-latest #tag-version ## Generate container tags for the `{version}` ans `latest` tags + +tag-latest: ## Generate container `{version}` tag + @echo 'create tag latest' + #docker tag $(APP_NAME) $(REPO)/$(APP_NAME):latest + #docker tag $(APP_NAME) $(GL_GROUP)/$(APP_NAME):latest + #docker tag $(APP_NAME) $(GL_REG_GROUP)/$(APP_NAME):latest + #docker tag $(APP_NAME) $(REG_NAME)/$(REPO)/$(APP_NAME):latest + #docker tag $(APP_NAME) $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME):latest + #docker tag $(APP_NAME) $(REPO)/$(APP_NAME):$(VERSION) + #docker tag $(APP_NAME) $(GL_GROUP)/$(APP_NAME):$(VERSION) + +tag-version: ## Generate container `latest` tag + @echo 'create tag $(VERSION)' + docker tag $(REPO)/$(APP_NAME):$(VERSION) $(REG_NAME)/$(REPO)/$(APP_NAME):$(VERSION) + +tag-alt: tag-alt-latest # tag-alt-version ## Generate container tags for the `{version}` ans `latest` tags + +tag-alt-latest: ## Generate container `{version}` tag + @echo 'create tag latest' + #docker tag $(APP_NAME)_$(ALT_NAME) $(REPO)/$(APP_NAME)_$(ALT_NAME):latest + #docker tag $(APP_NAME)_$(ALT_NAME) $(REG_NAME)/$(REPO)/$(APP_NAME)_$(ALT_NAME):latest + #docker tag $(APP_NAME)_$(ALT_NAME) $(REPO)/$(APP_NAME)_$(ALT_NAME):latest + #docker tag $(APP_NAME)_$(ALT_NAME) $(GL_GROUP)/$(APP_NAME)_$(ALT_NAME):latest + #docker tag $(APP_NAME)_$(ALT_NAME) $(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):latest + #docker tag $(APP_NAME)_$(ALT_NAME) $(REG_NAME)/$(REPO)/$(APP_NAME)_$(ALT_NAME):latest + #docker tag $(APP_NAME)_$(ALT_NAME) $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):latest + +tag-alt-version: ## Generate container `{version}` tag + @echo 'create tag latest' + docker tag $(APP_NAME)_$(ALT_NAME) $(REG_NAME)/$(REPO)/$(APP_NAME)_$(ALT_NAME):$(VERSION) + +# ========================================================================== +# +login: ## Auto login to AWS-ECR unsing aws-cli + docker login $(REG_NAME) -u $(REG_USER) -p $(REG_TOKEN) + +release: build-nc publish ## Make a release by building and publishing the `{version}` ans `latest` tagged containers to ECR + +publish: publish-latest #publish-version ## Publish the `{version}` ans `latest` tagged containers to ECR + +push: login ## push after login @echo 'push latest to $(REG_NAME)/$(REPO)/$(APP_NAME):latest' + docker tag $(APP_NAME):latest $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME):latest + docker push $(REG_HOST)/$(GL_REG_GROUP)/$(APP_NAME):latest + +publish-latest: ## Publish the `latest` taged container to ECR + @echo 'publish latest to $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)' + docker tag $(APP_NAME):latest $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME):latest + docker push $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME):latest + docker rmi $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME):latest + +publish-version: tag-version ## Publish the `{version}` taged container to ECR + @echo 'publish $(VERSION) to $(REPO)' + docker push $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME):$(VERSION) + +# ========================================================================== +# +release-alt: build-alt publish-alt ## Make a release by building and publishing the `{version}` ans `latest` tagged containers to ECR + +publish-alt: login publish-alt-latest #publish-alt-version ## Publish the `{version}` ans `latest` tagged containers to ECR + +push-alt: login tag-alt-latest ## push after login + #docker push $(REG_NAME)/$(REPO)/$(APP_NAME)_$(ALT_NAME):latest + docker push $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):latest + +publish-alt-latest: #tag-alt-latest ## Publish the `latest` taged container to ECR + #docker push $(REG_NAME)/$(REPO)/$(APP_NAME)_$(ALT_NAME):latest + docker tag $(APP_NAME)_$(ALT_NAME):latest $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):latest + docker push $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):latest + docker rmi $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):latest + +publish-alt-version: tag-alt-version ## Publish the `latest` taged container to ECR + #docker push $(REG_NAME)/$(REPO)/$(APP_NAME)_$(ALT_NAME):$(VERSION) + docker push $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):$(VERSION) + +# ========================================================================== +# + +login-dockerhub: ## login to hub.docker.com + @echo 'docker hub login :' + docker login + +push-dockerhub: build #publish-version ## Publish the `{version}` ans `latest` tagged containers to ECR + @echo '$(DH_ORG)/$(APP_NAME):$(TAG_VERSION)' + docker push $(DH_ORG)/$(APP_NAME):latest + #docker push $(DH_ORG)/$(APP_NAME):$(VERSION) + +publish-dockerhub: build tag #publish-version ## Publish the `{version}` ans `latest` tagged containers to ECR + @echo '$(DH_ORG)/$(APP_NAME):$(TAG_VERSION)' + docker push $(DH_ORG)/$(APP_NAME):latest + #docker push $(DH_ORG)/$(APP_NAME):$(VERSION) + +# ========================================================================== +# +clean-tags: + docker rmi $(REPO)/$(APP_NAME):latest || true + docker rmi $(GL_GROUP)/$(APP_NAME):latest || true + docker rmi $(GL_REG_GROUP)/$(APP_NAME):latest || true + docker rmi $(REG_NAME)/$(REPO)/$(APP_NAME):latest || true + docker rmi $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME):latest || true + docker rmi $(REPO)/$(APP_NAME)_$(ALT_NAME):latest || true + docker rmi $(GL_GROUP)/$(APP_NAME)_$(ALT_NAME):latest || true + docker rmi $(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):latest || true + docker rmi $(REG_NAME)/$(REPO)/$(APP_NAME)_$(ALT_NAME):latest || true + docker rmi $(REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):latest || true + +clean: + docker rmi $(REPO_NAME)/$(APP_NAME) || true + docker rmi $(REPO_NAME)/$(APP_NAME):$(TAG_VERSION) || true + docker rmi $(REPO_NAME)/$(APP_NAME):$(VERSION) || true + docker rmi $(REPO)/$(APP_NAME) || true + docker rmi $(REPO)/$(APP_NAME):$(TAG_VERSION) || true + docker rmi $(REPO)/$(APP_NAME):$(VERSION) || true + docker rmi $(REG_NAME)/$(REPO)/$(APP_NAME):latest || true + docker rmi $(REG_NAME)/$(REPO)/$(APP_NAME):$(TAG_VERSION) || true + docker rmi $(REG_NAME)/$(REPO)/$(APP_NAME) || true + docker rmi $(DH_ORG)/$(APP_NAME) || true + docker rmi $(DH_ORG)/$(APP_NAME):$(TAG_VERSION) || true + docker rmi $(DH_ORG)/$(APP_NAME):$(VERSION) || true + docker rmi $(GL_REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME):latest || true + docker rmi $(GL_REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME):$(VERSION) || true + docker rmi $(GL_REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME) || true + docker rmi $(GL_REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):latest || true + docker rmi $(GL_REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):$(VERSION) || true + docker rmi $(GL_REG_NAME)/$(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME) || true + docker rmi $(GL_REG_GROUP)/$(APP_NAME) || true + docker rmi $(GL_REG_GROUP)/$(APP_NAME):$(VERSION) || true + docker rmi $(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME) || true + docker rmi $(GL_REG_GROUP)/$(APP_NAME)_$(ALT_NAME):$(VERSION) || true + docker rmi $(GL_REG_NAME)/$(REG_USER)/$(APP_NAME) || true + docker rmi $(GL_REG_NAME)/$(REG_USER)/$(APP_NAME):$(VERSION) || true + #docker rmi $(APP_NAME) || true + +version: ## Output the current version + @echo $(VERSION) + +# ========================================================================== +# +info: ## Output the current version + @echo 'VERSION = $(VERSION) ' + @echo 'REG_USER = $(REG_USER) ' + @echo 'REG_NAME = $(REG_NAME) ' + @echo 'ALT_NAME = $(ALT_NAME) ' + @echo 'APP_NAME = $(APP_NAME) ' + @echo 'REPO_NAME = $(REPO_NAME) ' + @echo 'DH_ORG = $(DH_ORG) ' + @echo 'GL_GROUP = $(GL_GROUP) ' + @echo 'GL_REG_GROUP = $(GL_REG_GROUP)' + @echo 'GL_REG_NAME = $(GL_REG_NAME) ' + @echo 'REPO = $(REPO) ' + @echo 'TAG_VERSION = $(TAG_VERSION) ' + +ls: ## list all docker images + docker images diff --git a/containers/docker/README.md b/containers/docker/README.md new file mode 100644 index 0000000000000000000000000000000000000000..d6337961f1b7287f56f0b92aa3c87994f04abd55 --- /dev/null +++ b/containers/docker/README.md @@ -0,0 +1,18 @@ +Hall A/C Software +================= + + +Images for running containers for all aspects of the SANE experimental +analysis. + +The starting point is a pre-built image for the ROOT libraries. (ubuntu + ROOT) + +Main software libraries: + + - `evio`: Built from https://github.com/whit2333/hallac_evio + - `analyzer`: Hall A analyzer (podd)from https://github.com/whit2333/analyzer + - `hcana`: Hall C analyzer from https://github.com/whit2333/hcana + +These are all built using the super build project `cool_halls` (https://github.com/whit2333/cool_halls) + + diff --git a/containers/docker/config.env b/containers/docker/config.env new file mode 100644 index 0000000000000000000000000000000000000000..631951825ad49e88b62bd773e249dd89b9c01ac0 --- /dev/null +++ b/containers/docker/config.env @@ -0,0 +1,23 @@ +# Port to run the container +PORT=4000 + +REG_TOKEN ?= ${CI_IMAGE_BUILD_PAT} +REG_USER ?= whit +REG_NAME ?= eicweb.phy.anl.gov:4567 +REG_HOST ?= eicweb.phy.anl.gov:4567 + +# name of alternate build: +# Dockerfile.$(ALT_NAME) --> $(APP_NAME)_${ALT_NAME} +ALT_NAME ?= broadwell + +APP_NAME = hcana +REPO_NAME = hcana +DH_ORG = hallac +GL_GROUP = jlab/hallc/analyzer_software +GL_REG_GROUP = jlab/hallc/analyzer_software +GL_REG_NAME = hcana +REPO = hcana +TAG_VERSION = latest + + + diff --git a/containers/docker/deploy.env b/containers/docker/deploy.env new file mode 100644 index 0000000000000000000000000000000000000000..909aa72672001a5758a7f8c08619c7aa489defa1 --- /dev/null +++ b/containers/docker/deploy.env @@ -0,0 +1,5 @@ +# You have to define the values in {} +#DOCKER_REPO={account-nr}.dkr.ecr.{region}.amazonaws.com +## optional aws-cli options +#AWS_CLI_PROFILE={aws-cli-profile} +#AWS_CLI_REGION={aws-cli-region} diff --git a/containers/docker/usage.sh b/containers/docker/usage.sh new file mode 100644 index 0000000000000000000000000000000000000000..0b72b4786a77c190f0247a7f566fc50f93c914d6 --- /dev/null +++ b/containers/docker/usage.sh @@ -0,0 +1,26 @@ +# INSTALL +# - copy the files deploy.env, config.env, version.sh and Makefile to your repo +# - replace the vars in deploy.env +# - define the version script + +# Build the container +make build + +# Build and publish the container +make release + +# Publish a container to AWS-ECR. +# This includes the login to the repo +make publish + +# Run the container +make run + +# Build an run the container +make up + +# Stop the running container +make stop + +# Build the container with differnt config and deploy file +make cnf=another_config.env dpl=another_deploy.env build \ No newline at end of file diff --git a/containers/docker/version.sh b/containers/docker/version.sh new file mode 100644 index 0000000000000000000000000000000000000000..504899f94c6af4dcb28d4b7e6017c47614478b23 --- /dev/null +++ b/containers/docker/version.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +echo "0.1" diff --git a/containers/singularity/Singularity b/containers/singularity/Singularity new file mode 100644 index 0000000000000000000000000000000000000000..e57ff64c3eeaacf29147da31449d3b5ca9ba7ca3 --- /dev/null +++ b/containers/singularity/Singularity @@ -0,0 +1,125 @@ +Bootstrap: docker +From: eicweb.phy.anl.gov:4567/jlab/hallc/analyzer_software/hcana:latest + +%help + Hall A/C container. + Tools: + - evio : EVIO DAQ data format + - analyzer : Hall A analyzer (podd) + - hcana : Hall C analyzer (hcana) + - root : root version used for the analyzer + - rootls, rootbrowse, root_config + +%labels + Maintainer "Whitney Armstrong, Sylvester Joosten" + Version v1.0 + +%setup -c /bin/bash + export SINGULARITY_SHELL=/bin/bash + +%environment -c /bin/bash + export PYTHONPATH=/usr/local/lib:${PYTHONPATH} + export PATH=/usr/local/bin:${PATH} + export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH + export ROOT_INCLUDE_PATH=/usr/local/include:/usr/local/include/podd:/usr/local/include/hcana + +%post -c /bin/bash + echo "Hello from post" + echo "Install additional software here" + source /usr/local/bin/thisroot.sh + ## libformat and nlohmann json used heavily in new generation replay scripts + ## libformat + #cd /tmp && git clone https://github.com/fmtlib/fmt.git && cd fmt && \ + # git checkout 5.3.0 && mkdir /tmp/build && cd /tmp/build && \ + # cmake -DBUILD_SHARED_LIBS=TRUE ../fmt && + # make -j4 install && cd /tmp && rm -r /tmp/build && rm -r /tmp/fmt + ### json + +# ======================= +# global +# ======================= + +%runscript + echo "Launching a shell in the Hall A/C singularity container + exec bash + + +# ======================= +# root +# ======================= +%apprun root + root "$@" + +%appenv root + export PYTHONPATH=/usr/local/lib:${PYTHONPATH} + export PATH=/usr/local/bin:${PATH} + export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH + export ROOT_INCLUDE_PATH=/usr/local/include/podd:/usr/local/include/hcana + +# ======================= +# analyzer +# ======================= +%apprun analyzer + analyzer "$@" + +%appenv analyzer + export PYTHONPATH=/usr/local/lib:${PYTHONPATH} + export PATH=/usr/local/bin:${PATH} + export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH + export ROOT_INCLUDE_PATH=/usr/local/include/podd:/usr/local/include/hcana + +# ======================= +# hcana +# ======================= +%apphelp hcana + Run the Hall-C analyzer with same root-style arguments. + +%apprun hcana + source /usr/local/bin/thisroot.sh + hcana "$@" + +%appenv hcana + export DB_DIR=DBASE + export PYTHONPATH=/usr/local/lib:${PYTHONPATH} + export PATH=/usr/local/bin:${PATH} + export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH + export ROOTSYS=/usr/local + export ROOT_INCLUDE_PATH=/usr/local/include + export ROOT_INCLUDE_PATH=/usr/local/include:/usr/local/include/podd:/usr/local/include/hcana + +# ======================= +# root-config +# ======================= +%apprun root_config + root-config "$@" + +%appenv root_config + export PYTHONPATH=/usr/local/lib:${PYTHONPATH} + export PATH=/usr/local/bin:${PATH} + export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH + export ROOT_INCLUDE_PATH=/usr/local/include/podd:/usr/local/include/hcana + + +# ======================= +# rootbrowse +# ======================= +%apprun rootbrowse + rootbrowse "$@" + +%appenv rootbrowse + export PYTHONPATH=/usr/local/lib:${PYTHONPATH} + export PATH=/usr/local/bin:${PATH} + export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH + export ROOT_INCLUDE_PATH=/usr/local/include/podd:/usr/local/include/hcana + +# ======================= +# rootls +# ======================= +%apprun rootls + rootls "$@" + +%appenv rootls + export PYTHONPATH=/usr/local/lib:${PYTHONPATH} + export PATH=/usr/local/bin:${PATH} + export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH + export ROOT_INCLUDE_PATH=/usr/local/include/podd:/usr/local/include/hcana diff --git a/containers/singularity/Singularity.broadwell b/containers/singularity/Singularity.broadwell new file mode 100644 index 0000000000000000000000000000000000000000..8103edb5e0bf72456309b3220a1636cfe2a12fab --- /dev/null +++ b/containers/singularity/Singularity.broadwell @@ -0,0 +1,49 @@ +Bootstrap: docker +From: eicweb.phy.anl.gov:4567/whit/image_recipes/root_base_broadwell:latest + +%help + Help me. I'm in the container. + +%labels + Maintainer "Whitney Armstrong" + Version v1.0 + +%environment + export PYTHONPATH=/usr/local/lib:$PYTHONPATH + +%post -c /bin/bash + echo "Hello from post" + source /usr/local/bin/thisroot.sh + export PYTHONPATH=/usr/local/lib:$PYTHONPATH + git clone https://gitlab+deploy-token-1:FaNA-Yg4s7hpjvWPZnq8@eicweb.phy.anl.gov/upsilon/Pcsim.git + mkdir Pcsim/build && cd Pcsim/build + cmake ../. -DCOMPILE_FOR_BROADWELL:BOOL=ON + make -j20 + make install + + +%runscript + echo "Hello from runscirpt" + echo "Rooooar!" + echo "Arguments received: $*" + exec echo "$@" + +# derp= +# if [ -p /dev/stdin ]; then +# # If we want to read the input line by line +# while IFS= read line; do +# #echo "Line: ${line}" +# if [ -z ${derp} ]; then +# derp="${line}" +# else +# derp="${derp}\n${line}" +# fi +# done +# fi +# /bin/bash <<EOF +# source /usr/local/bin/geant4.sh +# echo -e ${derp} | bubble_chamber $@ +#EOF +# #exec /usr/local/bin/run_bubble_sim "$@" + + diff --git a/docs/libHallC_in_root.png b/docs/libHallC_in_root.png new file mode 100644 index 0000000000000000000000000000000000000000..0956db8783434e6faef684fe9aaa1cd33211bb1b Binary files /dev/null and b/docs/libHallC_in_root.png differ diff --git a/external/CMakeLists.txt b/external/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..8e22c5bae4ac780d66a9957a61e66ec24f0b9bfa --- /dev/null +++ b/external/CMakeLists.txt @@ -0,0 +1,31 @@ +cmake_minimum_required(VERSION 3.1) + +#message(STATUS "Subproject: PODD...") +# Download and unpack gflags at configure time +configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/PODD.CMakeLists.txt + ${CMAKE_BINARY_DIR}/PODD-download/CMakeLists.txt) + +execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" . + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/PODD-download) +if(result) + message(FATAL_ERROR "CMake step for PODD failed: ${result}") +endif() +execute_process(COMMAND ${CMAKE_COMMAND} --build . + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/PODD-download) +if(result) + message(FATAL_ERROR "Download step for exteranl PODD build failed: ${result}") +endif() + +add_subdirectory( + ${CMAKE_BINARY_DIR}/hallac_PODD-src + ${CMAKE_BINARY_DIR}/hallac_PODD-build) + +#execute_process(COMMAND "rm -r *" +# RESULT_VARIABLE result +# WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/PODD-download) + +message(STATUS "Subproject: PODD...DONE") + diff --git a/external/PODD.CMakeLists.txt b/external/PODD.CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..990247c5df8b8a9a7bb5a22690737ff370820b8d --- /dev/null +++ b/external/PODD.CMakeLists.txt @@ -0,0 +1,23 @@ +cmake_minimum_required(VERSION 3.5) + +# simplify variable expansion +#cmake_policy(SET CMP0053 NEW) +#cmake_policy(SET CMP0010 NEW) + +project(PODD-download NONE) + +include(ExternalProject) + +ExternalProject_Add(PODD_project + GIT_REPOSITORY https://github.com/whit2333/analyzer.git + GIT_TAG origin/master + SOURCE_DIR "${CMAKE_BINARY_DIR}/hallac_PODD-src" + BINARY_DIR "${CMAKE_BINARY_DIR}/hallac_PODD-build" + CMAKE_ARGS "-DCMAKE_INSTALL_PREFIX=@CMAKE_INSTALL_PREFIX@" "-DCMAKE_PREFIX_PATH=@CMAKE_INSTALL_PREFIX@" + BUILD_COMMAND ${CMAKE_COMMAND} --build . -- -j4 + USES_TERMINAL_BUILD ON + TEST_COMMAND "" + LOG_DOWNLOAD ON + ) +ExternalProject_Add_StepTargets(PODD_project install) + diff --git a/hc_compiledata.h.in b/hc_compiledata.h.in new file mode 100644 index 0000000000000000000000000000000000000000..b11ee5958e9ad9cdfb3c0d7d02c3e8152cc96fb9 --- /dev/null +++ b/hc_compiledata.h.in @@ -0,0 +1,39 @@ +#ifndef HCANA_COMPILEDATA_H +#define HCANA_COMPILEDATA_H + +#define HC_INCLUDEPATH "@CMAKE_INSTALL_PREFIX@/include" +#define HC_VERSION "@PROJECT_VERSION@" +#define HC_DATE "@HCANA_BUILD_DATE@" +#define HC_DATETIME "@HCANA_BUILD_DATETIME@" +#define HC_PLATFORM "@HCANA_PLATFORM@" +#define HC_BUILDNODE "@HCANA_NODE@" +#define HC_BUILDDIR "@HCANA_BUILD_DIR@" +#define HC_BUILDUSER "@HCANA_BUILD_USER@" +#define HC_GITVERS "@HCANA_GIT_VERSION@" +#define HC_CXXVERS "@HCANA_CXX_VERSION@" +#define HC_ROOTVERS "@HCANA_ROOT_VERSION@" + +#define HCANA_VERSION_CODE @HCANA_VERCODE@ +#define HCANA_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c)) +#endif + + +// Example: +//#ifndef ANALYZER_COMPILEDATA_H +//#define ANALYZER_COMPILEDATA_H +// +//#define HA_INCLUDEPATH "/mnt/old_home/whit/projects/hall_AC_projects/hcana/HCANA/src /mnt/old_home/whit/projects/hall_AC_projects/hcana/HCANA/hana_decode" +//#define HA_VERSION "1.6.0" +//#define HA_DATE "Jun 26 2018" +//#define HA_DATETIME "Tue Jun 26 2018" +//#define HA_PLATFORM "Linux-4.13.0-45-generic-x86_64-with-Ubuntu-17.10-artful" +//#define HA_BUILDNODE "wpad" +//#define HA_BUILDDIR "/mnt/old_home/whit/projects/hall_AC_projects/hcana/HCANA" +//#define HA_BUILDUSER "whit" +//#define HA_GITVERS "5b48832" +//#define HA_CXXVERS "c++ (GCC) 8.1.0" +//#define HA_ROOTVERS "6.15/01" +//#define ANALYZER_VERSION_CODE 67072 +//#define ANALYZER_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c)) +// +//#endif diff --git a/setup.csh b/setup.csh deleted file mode 100644 index 6a543dca881f5e6585c0f9eefd20873608a1826d..0000000000000000000000000000000000000000 --- a/setup.csh +++ /dev/null @@ -1,32 +0,0 @@ -#!/bin/csh - -if ( -r "./setup.csh" ) then - set MYDIR=`pwd` - if ($?prompt) then - echo "--> Setting HCANALYZER to '$MYDIR'" - endif -else - if ( "$1" == "" ) then - echo "ERROR: 'setup.csh' should have a path to the hcana location as its argument." - echo " Often this is also the location of the setup.csh script itself:" - echo " source /my/path/to/setup.csh /my/path/to/setup.csh" - echo " Or, if you have already cd'd into the hcana directory, then you can call:" - echo ' source setup.csh `pwd`' - exit 1 - else - set MYDIR=$1 - endif -endif - -setenv ANALYZER $MYDIR/podd -setenv HCANALYZER $MYDIR -# Check if LD_LIBRARY_PATH is defined -if ( ! ($?LD_LIBRARY_PATH) ) then - setenv LD_LIBRARY_PATH "" -endif -# Check if DYLD_LIBRARY_PATH is defined -if ( ! ($?DYLD_LIBRARY_PATH) ) then - setenv DYLD_LIBRARY_PATH "" -endif -setenv LD_LIBRARY_PATH "${LD_LIBRARY_PATH}:${ANALYZER}:${HCANALYZER}" -setenv DYLD_LIBRARY_PATH "${DYLD_LIBRARY_PATH}:${ANALYZER}:${HCANALYZER}" diff --git a/setup.sh b/setup.sh deleted file mode 100644 index 62be0dad2ae43c916d81ddb24c29a974f0d2d505..0000000000000000000000000000000000000000 --- a/setup.sh +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/bash - -MYDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -export ANALYZER=${MYDIR}/podd -export HCANALYZER=${MYDIR} -# Check if defined -if [ ! ${LD_LIBRARY_PATH} ]; then - export LD_LIBRARY_PATH="" -fi -if [ ! ${DYLD_LIBRARY_PATH} ]; then - export DYLD_LIBRARY_PATH="" -fi -export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ANALYZER:$HCANALYZER -export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$ANALYZER:$HCANALYZER diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 66d869664a1c5789cb5e5cc6d990dcd39de1e2a0..9ffd6d9295148c640e6e4c91afdade8dce3b83f7 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -4,11 +4,12 @@ cmake_minimum_required(VERSION 3.5) # Names of the main items we build here set(LIBNAME HallC) set(EXENAME hcana) +include(FindThreads) #---------------------------------------------------------------------------- # Sources and headers file(GLOB src "*.cxx") -file(GLOB allheaders "*.h") +file(GLOB allheaders RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} "*.h") list(REMOVE_ITEM allheaders "${CMAKE_CURRENT_SOURCE_DIR}/${LIBNAME}_LinkDef.h" ) @@ -55,10 +56,16 @@ add_library(${LIBNAME} SHARED ${src} ${allheaders} ${LIBNAME}Dict.cxx) add_library(${PROJECT_NAME}::${LIBNAME} ALIAS ${LIBNAME}) target_include_directories(${LIBNAME} - PUBLIC + PUBLIC #$<INSTALL_INTERFACE:include> $<INSTALL_INTERFACE:include> $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}> + $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include> + $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/hcana> + $<BUILD_INTERFACE:${Podd_DIR}/../../include/podd2> $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}> # for hc_compiledata.h + $<BUILD_INTERFACE:${SPDLOG_INCLUDE_DIR}> + $<INSTALL_INTERFACE:${SPDLOG_INCLUDE_DIR}> + $<BUILD_INTERFACE:${FMT_INCLUDE_DIR}> ) target_compile_options(${LIBNAME} @@ -89,12 +96,24 @@ install(TARGETS ${LIBNAME} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} ) install(FILES ${allheaders} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) +#install(DIRECTORY nlohmann DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) + +install(DIRECTORY include/hcana DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) +#install(DIRECTORY include/spdlog DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/hcana) #---------------------------------------------------------------------------- # libHallCDict build_root_dictionary(${LIBNAME} ${headers} + INCLUDEDIRS + $<BUILD_INTERFACE:-I${SPDLOG_INCLUDE_DIR}> + $<BUILD_INTERFACE:-I${FMT_INCLUDE_DIR}> + -I${CMAKE_CURRENT_SOURCE_DIR} + -I${CMAKE_CURRENT_SOURCE_DIR}/include + -I${CMAKE_CURRENT_SOURCE_DIR}/include/hcana + -I${Podd_DIR}/../../include + -I${Podd_DIR}/../../include/podd2 TARGETS ${LIBNAME} - LINKDEF ${linkdef} + LINKDEF include/HallC_LinkDef.h ) #---------------------------------------------------------------------------- diff --git a/src/Scandalizer.cxx b/src/Scandalizer.cxx new file mode 100644 index 0000000000000000000000000000000000000000..5c2c1126d199de236acbce5297be655a00bce66b --- /dev/null +++ b/src/Scandalizer.cxx @@ -0,0 +1,325 @@ +#include "Scandalizer.h" +#include "THaRun.h" + +using namespace std; + +namespace hcana { + +Int_t Scandalizer::ReadOneEvent() +{ + // Read one event from current run (fRun) and raw-decode it using the + // current decoder (fEvData) + + if( fDoBench ) {fBench->Begin("RawDecode");} + + bool to_read_file = false; + if( !fEvData->IsMultiBlockMode() || + (fEvData->IsMultiBlockMode() && fEvData->BlockIsDone()) ){ + to_read_file = true; + } + + // Find next event buffer in CODA file. Quit if error. + Int_t status = THaRunBase::READ_OK; + + while(_skip_events > 0 ) { + _logger->debug("non-zero skip_events: {}", _skip_events); + int skipped = 0; + auto run = dynamic_cast<THaRun*>(fRun); + if( run ) { + skipped = run->SkipToEndOfFile(_skip_events); + } + _skip_events = 0; + _logger->info("skipped {} events", skipped); + continue; + } + if (to_read_file){ + status = fRun->ReadEvent(); + } + + // there may be a better place to do this, but this works + if (fWantCodaVers > 0) { + fEvData->SetDataVersion(fWantCodaVers); + } else { + fEvData->SetDataVersion(fRun->GetDataVersion()); + } + + switch( status ) { + case THaRunBase::READ_OK: + // Decode the event + if (to_read_file) { + status = fEvData->LoadEvent( fRun->GetEvBuffer() ); + } else { + status = fEvData->LoadFromMultiBlock( ); // load next event in block + } + switch( status ) { + case THaEvData::HED_WARN: + //std::cout << "HED_WARN\n"; + case THaEvData::HED_OK: // fall through + status = THaRunBase::READ_OK; + Incr(kNevRead); + break; + case THaEvData::HED_ERR: + // Decoding error + status = THaRunBase::READ_ERROR; + Incr(kDecodeErr); + break; + case THaEvData::HED_FATAL: + status = THaRunBase::READ_FATAL; + break; + } + break; + + case THaRunBase::READ_EOF: // fall through + std::cout << " READ_EOF\n"; + case THaRunBase::READ_FATAL: + // Just exit on EOF - don't count it + break; + default: + Incr(kCodaErr); + break; + } + + if( fDoBench ) {fBench->Stop("RawDecode");} + return status; +} + +Int_t Scandalizer::Process( THaRunBase* run ) +{ + // Process the given run. Loop over all events in the event range and + // analyze all apparatuses defined in the global apparatus list. + // Fill Event structure if it is defined. + // If Event and Filename are defined, then fill the output tree with Event + // and write the file. + + static const char* const here = "Scandalizer::Process"; + + if( !run ) { + if( fRun ){ + run = fRun; + } else { + return -1; + } + } + + //--- Initialization. Creates fFile, fOutput, and fEvent if necessary. + // Also copies run to fRun if run is different from fRun + Int_t status = Init( run ); + if( status != 0 ) { + return status; + } + + // Restart "Total" since it is stopped in Init() + fBench->Begin("Total"); + + //--- Re-open the data source. Should succeed since this was tested in Init(). + if( (status = fRun->Open()) != THaRunBase::READ_OK ) { + Error( here, "Failed to re-open the input file. " + "Make sure the file still exists."); + fBench->Stop("Total"); + return -4; + } + + // Make the current run available globally - the run parameters are + // needed by some modules + gHaRun = fRun; + + // Enable/disable helicity decoding as requested + fEvData->EnableHelicity( HelicityEnabled() ); + // Set decoder reporting level. FIXME: update when THaEvData is updated + fEvData->SetVerbose( (fVerbose>2) ); + fEvData->SetDebug( (fVerbose>3) ); + + // Informational messages + if( fVerbose>1 ) { + _logger->info("Decoder: helicity {}", (fEvData->HelicityEnabled() ? "enabled" : "disabled")); + _logger->trace("Starting analysis in {}",here); + } + if( fVerbose>1 && fRun->GetFirstEvent()>1 ) { + _logger->debug("Skipping {} events", fRun->GetFirstEvent()); + } + + //--- The main event loop. + + fNev = 0; + bool terminate = false, fatal = false; + UInt_t nlast = fRun->GetLastEvent(); + fAnalysisStarted = kTRUE; + BeginAnalysis(); + if( fFile ) { + fFile->cd(); + fRun->Write("Run_Data"); // Save run data to first ROOT file + } + void (*prev_handler)(int); + prev_handler = signal (SIGINT, handle_sig); + + while ( !terminate && (fNev < nlast)) { + //&& (status = ReadOneEvent()) != THaRunBase::READ_EOF ) + //std::cout << " evtype(last) " << fEvData->GetEvType() << "\n"; + status = ReadOneEvent(); + + // If an interupt signal is sent (ctrl-c) + if(sig_caught) { + terminate = true; + break; + } + + if( status == THaRunBase::READ_EOF ) { + break; + } + + //--- Skip events with errors, unless fatal + if( status == THaRunBase::READ_FATAL ){ + std::cout << " READ_FATAL\n"; + break; + } + if( status != THaRunBase::READ_OK ){ + continue; + } + + UInt_t evnum = fEvData->GetEvNum(); + + // Count events according to the requested mode + // Whether or not to ignore events prior to fRun->GetFirstEvent() + // is up to the analysis routines. + switch (fCountMode) { + case kCountPhysics: + if (fEvData->IsPhysicsTrigger()) + fNev++; + break; + case kCountAll: + fNev++; + break; + case kCountRaw: + fNev = evnum; + break; + default: + break; + } + + //--- Print marks periodically + if( (fVerbose>1) && (evnum > 0) && (evnum % fMarkInterval == 0)){ + _logger->info("Run {:5}, event {:8}", fRun->GetNumber(), evnum); + } + // Auto save file so it is not junk and can be processed while we write + if( (evnum > 0) &&(evnum % fAutoSaveInterval == 0)){ + fOutput->GetTree()->AutoSave("SaveSelf"); + } + + + + //--- Update run parameters with current event + if( fUpdateRun ){ + fRun->Update( fEvData ); + } + + //--- Clear all tests/cuts + if( fDoBench ) {fBench->Begin("Cuts");} + gHaCuts->ClearAll(); + if( fDoBench ) {fBench->Stop("Cuts");} + + //--- Perform the analysis + Int_t err = MainAnalysis(); + switch( err ) { + case kOK: + break; + case kSkip: + continue; + case kFatal: + fatal = terminate = true; + continue; + case kTerminate: + terminate = true; + break; + default: + _logger->error( "{} : Unknown return code from MainAnalysis(): {}",here, err ); + terminate = fatal = true; + continue; + } + + Incr(kNevAccepted); + + } // End of event loop + + // restore the previous signal handler + signal (SIGINT, prev_handler); + EndAnalysis(); + + //--- Close the input file + fRun->Close(); + + // Save final run parameters in run object of caller, if any + *run = *fRun; + + // Write the output file and clean up. + // This writes the Tree as well as any objects (histograms etc.) + // that are defined in the current directory. + + if( fDoBench ) fBench->Begin("Output"); + // Ensure that we are in the output file's current directory + // ... someone might have pulled the rug from under our feet + + // get the CURRENT file, since splitting might have occurred + if( fOutput && fOutput->GetTree() ) + fFile = fOutput->GetTree()->GetCurrentFile(); + if( fFile ) fFile->cd(); + if( fOutput ) fOutput->End(); + if( fFile ) { + fRun->Write("Run_Data"); // Save run data to ROOT file + // fFile->Write();//already done by fOutput->End() + fFile->Purge(); // get rid of excess object "cycles" + } + if( fDoBench ) fBench->Stop("Output"); + + fBench->Stop("Total"); + + //--- Report statistics + if( fVerbose>0 ) { + cout << dec; + if( status == THaRunBase::READ_EOF ){ + _logger->info("End of file status, THaRunBase::READ_EOF"); + } + else if ( fNev == nlast ) { + _logger->info("Event limit reached."); + } else if ( fatal ) { + _logger->error("Fatal processing error."); + } else if ( terminate ) { + _logger->warn("Terminated during processing."); + } + + if( !fatal ) { + PrintCounters(); + //if (fVerbose > 1) { + // PrintScalers(); + //} + } + } + + // Print cut summary (also to file if one given) + //if( !fatal ) { + // PrintCutSummary(); + //} + + // Print timing statistics, if benchmarking enabled + if( fDoBench && !fatal ) { + cout << "Timing summary:" << endl; + fBench->Print("Init"); + fBench->Print("RawDecode"); + fBench->Print("Decode"); + fBench->Print("CoarseTracking"); + fBench->Print("CoarseReconstruct"); + fBench->Print("Tracking"); + fBench->Print("Reconstruct"); + fBench->Print("Physics"); + fBench->Print("Output"); + fBench->Print("Cuts"); + } + if( (fVerbose>1 && fDoBench) && !fatal ){ + fBench->Print("Total"); + } + + //keep the last run available + // gHaRun = NULL; + return fNev; +} + +} diff --git a/src/Scandalizer.h b/src/Scandalizer.h new file mode 100644 index 0000000000000000000000000000000000000000..ab2a41d615eac4b4e263d9d2ed43c1d337668831 --- /dev/null +++ b/src/Scandalizer.h @@ -0,0 +1,26 @@ +#ifndef hcana_Scandalizer_h_ +#define hcana_Scandalizer_h_ + +#include "THaBenchmark.h" +#include "THcAnalyzer.h" +#include <iostream> + + +namespace hcana { + + class Scandalizer : public THcAnalyzer { + public: + Scandalizer() : THcAnalyzer() {} + virtual ~Scandalizer() {} + + virtual Int_t Process(THaRunBase* run = nullptr); + virtual Int_t ReadOneEvent(); + //Int_t GoToEndOfCodaFile(); + + int _skip_events = 0; + + ClassDef(Scandalizer, 0) // Hall C Analyzer Standard Event Loop + }; + +} // namespace hcana +#endif diff --git a/src/Shower2.cxx b/src/Shower2.cxx new file mode 100644 index 0000000000000000000000000000000000000000..1e9f16b63af856f98df15e42b0ad100026aba330 --- /dev/null +++ b/src/Shower2.cxx @@ -0,0 +1,110 @@ +#include "Shower2.h" + +#include "THcShower.h" +#include "THcHallCSpectrometer.h" +#include "THaEvData.h" +#include "THaDetMap.h" +#include "THcDetectorMap.h" +#include "THcGlobals.h" +#include "THaCutList.h" +#include "THcParmList.h" +#include "VarDef.h" +#include "VarType.h" +#include "THaTrack.h" +#include "TClonesArray.h" +#include "THaTrackProj.h" +#include "TMath.h" + +#include <cstring> +#include <cstdio> +#include <cstdlib> +#include <iostream> +#include <numeric> + +#include "nlohmann/json.hpp" + +using namespace std; + +namespace hcana { + +THaAnalysisObject::EStatus Shower2::Init(const TDatime &date) { + + auto res = THcShower::Init(date); + + LoadJsonCalibration(_run_number); + + // hard coding cal_*_cal_const to 0.001. + // Not sure what their purpose is... + + for (UInt_t i=0; i<fNTotBlocks; i++) { + fPosGain[i] = 0.001 * _pos_gain_cor[i]; + fNegGain[i] = 0.001 * _neg_gain_cor[i]; + } + + if(fHasArray) { + auto gains = fArray->GetGains(); + for (Int_t i=0; i<fArray->GetNelem(); i++) { + gains[i] = 0.001 * _arr_gain_cor[i]; + } + } + + return fStatus = res; +} + +void Shower2::LoadJsonCalibration(int rn, std::string fname) { + // file checks assumed already complete. + using nlohmann::json; + json j_database; + { + std::ifstream json_input_file(fname); + json_input_file >> j_database; + } + + std::cout << " runs : "; + std::vector<int> runs; + for (json::iterator it = j_database.begin(); it != j_database.end(); ++it) { + std::cout << it.key() << ", "; + runs.push_back(std::stoi(it.key())); + } + std::cout << "\n"; + + auto closest = [](std::vector<int> const &vec, int value) { + auto it = std::lower_bound(vec.begin(), vec.end(), value); + if (*it > value) { + it = it - 1; + } + if (it == vec.end()) { + return -1; + } + return *it; + }; + // auto best_run = std::upper_bound(runs.begin(), runs.end(), rn); + // std::cout << "using run upper " << rn << " :::: " << *best_run << "\n"; + // auto best_run = std::lower_bound(runs.begin(), runs.end(), rn); + // std::cout << "using run lower " << rn << " :::: " << *(best_run) << "\n"; + + int best_run = closest(runs, rn); + std::cout << " closest " << best_run << std::endl; + json j = j_database[std::to_string(best_run)]; + // std::cout << j_database[std::to_string(best_run)] << "\n";; + // std::cout << j.dump(-1) << "\n"; + + + if (j.find("histogram") != j.end()) { + } + if (j.find("cal") != j.end()) { + json j_cal = j["cal"]; + if (j_cal.find("neg_gain_cor") != j_cal.end()) { + // std::cout << " neg_gain_cor!!!\n"; + _neg_gain_cor = j["cal"]["neg_gain_cor"].get<std::vector<double>>(); + } + if (j_cal.find("pos_gain_cor") != j_cal.end()) { + _pos_gain_cor = j["cal"]["pos_gain_cor"].get<std::vector<double>>(); + } + if (j_cal.find("arr_gain_cor") != j_cal.end()) { + _arr_gain_cor = j["cal"]["arr_gain_cor"].get<std::vector<double>>(); + } + } +} + +} // namespace hcana diff --git a/src/Shower2.h b/src/Shower2.h new file mode 100644 index 0000000000000000000000000000000000000000..a33e6961d104ef48d3cede926498b40fd956a359 --- /dev/null +++ b/src/Shower2.h @@ -0,0 +1,44 @@ +#ifndef ROOT_hcana_Shower2 +#define ROOT_hcana_Shower2 + +/////////////////////////////////////////////////////////////////////////////// +// // +// hcana::Shower // +// // +/////////////////////////////////////////////////////////////////////////////// + +#include "THcShower.h" +#include "TObject.h" + +namespace hcana { + +class Shower2 : public THcShower { + +public: + Shower2(const char *name, const char *description = "", + THaApparatus *a = nullptr) + : THcShower(name, description, a) {} + + virtual ~Shower2(){} + + virtual THaAnalysisObject::EStatus Init(const TDatime &run_time); + + int _run_number = 0; + std::vector<double> _neg_gain_cor; + std::vector<double> _pos_gain_cor; + std::vector<double> _arr_gain_cor; + + void SetRunNumber(int rn) { _run_number = rn;} + void LoadJsonCalibration(int rn, std::string fname = "PARAM/SHMS/CAL/pcal_calib.json"); + + // virtual void Clear( Option_t* opt="" ); + // virtual Int_t Decode( const THaEvData& ); + // virtual Int_t CoarseProcess( TClonesArray& tracks ); + // virtual Int_t FineProcess( TClonesArray& tracks ); + + ClassDef(Shower2, 1) // Shower counter detector +}; + +} // namespace hcana + +#endif diff --git a/src/THcAerogel.cxx b/src/THcAerogel.cxx index cca8b1e8a4582c4f3d54ec5b60c76af22856d724..026613d38e6f030154fde1b3689c054f9e219900 100644 --- a/src/THcAerogel.cxx +++ b/src/THcAerogel.cxx @@ -36,7 +36,8 @@ using namespace std; //_____________________________________________________________________________ THcAerogel::THcAerogel( const char* name, const char* description, THaApparatus* apparatus ) : - THaNonTrackingDetector(name,description,apparatus), fPresentP(0), + THaNonTrackingDetector(name,description,apparatus), + fPresentP(0), fAdcPosTimeWindowMin(0), fAdcPosTimeWindowMax(0), fAdcNegTimeWindowMin(0), fAdcNegTimeWindowMax(0),fPedNegDefault(0),fPedPosDefault(0), fRegionValue(0), fPosGain(0), fNegGain(0), @@ -168,7 +169,7 @@ THaAnalysisObject::EStatus THcAerogel::Init( const TDatime& date ) EngineDID[0] = toupper(GetApparatus()->GetName()[0]); if( gHcDetectorMap->FillMap(fDetMap, EngineDID) < 0 ) { static const char* const here = "Init()"; - Error( Here(here), "Error filling detectormap for %s.", EngineDID ); + _det_logger->error( "{} Error filling detectormap for {}.", "THcAerogel::Init", EngineDID ); return kInitError; } @@ -185,7 +186,7 @@ THaAnalysisObject::EStatus THcAerogel::Init( const TDatime& date ) if( !app || !(fglHod = dynamic_cast<THcHodoscope*>(app->GetDetector("hod"))) ) { static const char* const here = "ReadDatabase()"; - Warning(Here(here),"Hodoscope \"%s\" not found. ","hod"); + _det_logger->warn("{} Hodoscope \"{}\" not found. ",Here(here),"hod"); } fPresentP = 0; @@ -221,8 +222,9 @@ Int_t THcAerogel::ReadDatabase( const TDatime& date ) Bool_t optional = true; - cout << "Created aerogel detector " << GetApparatus()->GetName() << "." - << GetName() << " with " << fNelem << " PMT pairs" << endl; + _det_logger->info("Created aerogel detector {}.{} with {} PMT pairs.", GetApparatus()->GetName(), GetName(), fNelem); + //cout << "Created aerogel detector " << GetApparatus()->GetName() << "." + // << GetName() << " with " << fNelem << " PMT pairs" << endl; DeleteArrays(); // avoid memory leak when reinitializing diff --git a/src/THcAerogel.h b/src/THcAerogel.h index 71246ffd5f262714163c38df088a14849cf2b52a..642e60525d50377275f3b7c22aa39c9a7e03fc0c 100644 --- a/src/THcAerogel.h +++ b/src/THcAerogel.h @@ -11,6 +11,9 @@ #include "THaNonTrackingDetector.h" #include "THcHitList.h" #include "THcAerogelHit.h" + +#include "hcana/Logger.h" + class THcHodoscope; class THcAerogel : public THaNonTrackingDetector, public THcHitList { diff --git a/src/THcAnalyzer.cxx b/src/THcAnalyzer.cxx index 3f2b619010fdbe93feff0aa5e055926a1de57780..24729fa947907322110c6b94f386cb6841356b0b 100644 --- a/src/THcAnalyzer.cxx +++ b/src/THcAnalyzer.cxx @@ -37,7 +37,7 @@ using namespace std; // do we need to "close" scalers/EPICS analysis if we reach the event limit? //_____________________________________________________________________________ -THcAnalyzer::THcAnalyzer() +THcAnalyzer::THcAnalyzer() : THaAnalyzer() { } @@ -174,7 +174,4 @@ void THcAnalyzer::LoadInfo() *lastevent = fRun->GetFirstEvent()+fRun->GetNumAnalyzed(); } -//_____________________________________________________________________________ - -ClassImp(THcAnalyzer) diff --git a/src/THcAnalyzer.h b/src/THcAnalyzer.h index d5bd10bae17f11b4980e128a8d0745ae4c8f335b..80208f02d1b44ed4153f98f7c0dee446c80447e6 100644 --- a/src/THcAnalyzer.h +++ b/src/THcAnalyzer.h @@ -8,6 +8,41 @@ ////////////////////////////////////////////////////////////////////////// #include "THaAnalyzer.h" +#include "THaRunBase.h" +#include "THaEvent.h" +#include "THaOutput.h" +#include "THaEvData.h" +#include "THaGlobals.h" +#include "THaSpectrometer.h" +#include "THaNamedList.h" +#include "THaCutList.h" +#include "THaCut.h" +#include "THaPhysicsModule.h" +#include "THaPostProcess.h" +#include "THaBenchmark.h" +#include "THaEvtTypeHandler.h" +#include "THaEpicsEvtHandler.h" +#include "TList.h" +#include "TTree.h" +#include "TFile.h" +#include "TClass.h" +#include "TDatime.h" +#include "TClass.h" +#include "TError.h" +#include "TSystem.h" +#include "TROOT.h" +#include "TMath.h" +#include "TDirectory.h" +#include "THaCrateMap.h" + +#include <algorithm> +#include <csignal> +#include <cstring> +#include <exception> +#include <fstream> +#include <iomanip> +#include <iostream> +#include <stdexcept> class THcAnalyzer : public THaAnalyzer { diff --git a/src/THcCherenkov.cxx b/src/THcCherenkov.cxx index f95b339a85d4ea92a03cd2c126bcf3e74758a66b..0ccb5649b04ff0896bbb19417e5ca0c41c39a2d2 100644 --- a/src/THcCherenkov.cxx +++ b/src/THcCherenkov.cxx @@ -6,79 +6,73 @@ */ #include "THcCherenkov.h" -#include "THcHodoscope.h" #include "TClonesArray.h" -#include "THcSignalHit.h" -#include "THaEvData.h" +#include "THaApparatus.h" +#include "THaCutList.h" #include "THaDetMap.h" +#include "THaEvData.h" +#include "THaTrack.h" +#include "THaTrackProj.h" #include "THcDetectorMap.h" #include "THcGlobals.h" -#include "THaCutList.h" -#include "THcParmList.h" +#include "THcHallCSpectrometer.h" #include "THcHitList.h" -#include "THaApparatus.h" +#include "THcHodoscope.h" +#include "THcParmList.h" +#include "THcSignalHit.h" +#include "TMath.h" #include "VarDef.h" #include "VarType.h" -#include "THaTrack.h" -#include "TClonesArray.h" -#include "TMath.h" -#include "THaTrackProj.h" -#include "THcHallCSpectrometer.h" #include <algorithm> -#include <cstring> #include <cstdio> #include <cstdlib> +#include <cstring> +#include <iomanip> #include <iostream> #include <string> -#include <iomanip> - using namespace std; -using std::cout; using std::cin; +using std::cout; using std::endl; -using std::setw; using std::setprecision; +using std::setw; //_____________________________________________________________________________ -THcCherenkov::THcCherenkov( const char* name, const char* description, - THaApparatus* apparatus ) : - THaNonTrackingDetector(name,description,apparatus) -{ +THcCherenkov::THcCherenkov(const char* name, const char* description, THaApparatus* apparatus) + : THaNonTrackingDetector(name, description, apparatus) { // Normal constructor with name and description - frAdcPedRaw = new TClonesArray("THcSignalHit", MaxNumCerPmt*MaxNumAdcPulse); - frAdcPulseIntRaw = new TClonesArray("THcSignalHit", MaxNumCerPmt*MaxNumAdcPulse); - frAdcPulseAmpRaw = new TClonesArray("THcSignalHit", MaxNumCerPmt*MaxNumAdcPulse); - frAdcPulseTimeRaw = new TClonesArray("THcSignalHit", MaxNumCerPmt*MaxNumAdcPulse); - frAdcPed = new TClonesArray("THcSignalHit", MaxNumCerPmt*MaxNumAdcPulse); - frAdcPulseInt = new TClonesArray("THcSignalHit", MaxNumCerPmt*MaxNumAdcPulse); - frAdcPulseAmp = new TClonesArray("THcSignalHit", MaxNumCerPmt*MaxNumAdcPulse); - frAdcPulseTime = new TClonesArray("THcSignalHit", MaxNumCerPmt*MaxNumAdcPulse); - fAdcErrorFlag = new TClonesArray("THcSignalHit", MaxNumCerPmt*MaxNumAdcPulse); - - fNumAdcHits = vector<Int_t> (MaxNumCerPmt, 0.0); - fNumGoodAdcHits = vector<Int_t> (MaxNumCerPmt, 0.0); - fNumTracksMatched = vector<Int_t> (MaxNumCerPmt, 0.0); - fNumTracksFired = vector<Int_t> (MaxNumCerPmt, 0.0); - fNpe = vector<Double_t> (MaxNumCerPmt, 0.0); - fGoodAdcPed = vector<Double_t> (MaxNumCerPmt, 0.0); - fGoodAdcMult = vector<Double_t> (MaxNumCerPmt, 0.0); - fGoodAdcHitUsed = vector<Double_t> (MaxNumCerPmt, 0.0); - fGoodAdcPulseInt = vector<Double_t> (MaxNumCerPmt, 0.0); - fGoodAdcPulseIntRaw = vector<Double_t> (MaxNumCerPmt, 0.0); - fGoodAdcPulseAmp = vector<Double_t> (MaxNumCerPmt, 0.0); - fGoodAdcPulseTime = vector<Double_t> (MaxNumCerPmt, 0.0); - fGoodAdcTdcDiffTime = vector<Double_t> (MaxNumCerPmt, 0.0); + frAdcPedRaw = new TClonesArray("THcSignalHit", MaxNumCerPmt * MaxNumAdcPulse); + frAdcPulseIntRaw = new TClonesArray("THcSignalHit", MaxNumCerPmt * MaxNumAdcPulse); + frAdcPulseAmpRaw = new TClonesArray("THcSignalHit", MaxNumCerPmt * MaxNumAdcPulse); + frAdcPulseTimeRaw = new TClonesArray("THcSignalHit", MaxNumCerPmt * MaxNumAdcPulse); + frAdcPed = new TClonesArray("THcSignalHit", MaxNumCerPmt * MaxNumAdcPulse); + frAdcPulseInt = new TClonesArray("THcSignalHit", MaxNumCerPmt * MaxNumAdcPulse); + frAdcPulseAmp = new TClonesArray("THcSignalHit", MaxNumCerPmt * MaxNumAdcPulse); + frAdcPulseTime = new TClonesArray("THcSignalHit", MaxNumCerPmt * MaxNumAdcPulse); + fAdcErrorFlag = new TClonesArray("THcSignalHit", MaxNumCerPmt * MaxNumAdcPulse); + + fNumAdcHits = vector<Int_t>(MaxNumCerPmt, 0.0); + fNumGoodAdcHits = vector<Int_t>(MaxNumCerPmt, 0.0); + fNumTracksMatched = vector<Int_t>(MaxNumCerPmt, 0.0); + fNumTracksFired = vector<Int_t>(MaxNumCerPmt, 0.0); + fNpe = vector<Double_t>(MaxNumCerPmt, 0.0); + fGoodAdcPed = vector<Double_t>(MaxNumCerPmt, 0.0); + fGoodAdcMult = vector<Double_t>(MaxNumCerPmt, 0.0); + fGoodAdcHitUsed = vector<Double_t>(MaxNumCerPmt, 0.0); + fGoodAdcPulseInt = vector<Double_t>(MaxNumCerPmt, 0.0); + fGoodAdcPulseIntRaw = vector<Double_t>(MaxNumCerPmt, 0.0); + fGoodAdcPulseAmp = vector<Double_t>(MaxNumCerPmt, 0.0); + fGoodAdcPulseTime = vector<Double_t>(MaxNumCerPmt, 0.0); + fGoodAdcTdcDiffTime = vector<Double_t>(MaxNumCerPmt, 0.0); InitArrays(); } //_____________________________________________________________________________ -THcCherenkov::THcCherenkov( ) : - THaNonTrackingDetector() -{ +THcCherenkov::THcCherenkov() { // Constructor frAdcPedRaw = NULL; frAdcPulseIntRaw = NULL; @@ -94,25 +88,32 @@ THcCherenkov::THcCherenkov( ) : } //_____________________________________________________________________________ -THcCherenkov::~THcCherenkov() -{ +THcCherenkov::~THcCherenkov() { // Destructor - delete frAdcPedRaw; frAdcPedRaw = NULL; - delete frAdcPulseIntRaw; frAdcPulseIntRaw = NULL; - delete frAdcPulseAmpRaw; frAdcPulseAmpRaw = NULL; - delete frAdcPulseTimeRaw; frAdcPulseTimeRaw = NULL; - delete frAdcPed; frAdcPed = NULL; - delete frAdcPulseInt; frAdcPulseInt = NULL; - delete frAdcPulseAmp; frAdcPulseAmp = NULL; - delete frAdcPulseTime; frAdcPulseTime = NULL; - delete fAdcErrorFlag; fAdcErrorFlag = NULL; + delete frAdcPedRaw; + frAdcPedRaw = NULL; + delete frAdcPulseIntRaw; + frAdcPulseIntRaw = NULL; + delete frAdcPulseAmpRaw; + frAdcPulseAmpRaw = NULL; + delete frAdcPulseTimeRaw; + frAdcPulseTimeRaw = NULL; + delete frAdcPed; + frAdcPed = NULL; + delete frAdcPulseInt; + frAdcPulseInt = NULL; + delete frAdcPulseAmp; + frAdcPulseAmp = NULL; + delete frAdcPulseTime; + frAdcPulseTime = NULL; + delete fAdcErrorFlag; + fAdcErrorFlag = NULL; DeleteArrays(); } //_____________________________________________________________________________ -void THcCherenkov::InitArrays() -{ +void THcCherenkov::InitArrays() { fGain = NULL; fPedSum = NULL; fPedSum2 = NULL; @@ -123,11 +124,12 @@ void THcCherenkov::InitArrays() fThresh = NULL; } //_____________________________________________________________________________ -void THcCherenkov::DeleteArrays() -{ - delete [] fGain; fGain = NULL; +void THcCherenkov::DeleteArrays() { + delete[] fGain; + fGain = NULL; // 6 Gev variables + delete [] fPedSum; fPedSum = NULL; delete [] fPedSum2; fPedSum2 = NULL; delete [] fPedLimit; fPedLimit = NULL; @@ -140,48 +142,45 @@ void THcCherenkov::DeleteArrays() delete [] fAdcTimeWindowMin; fAdcTimeWindowMin = 0; delete [] fAdcTimeWindowMax; fAdcTimeWindowMax = 0; delete [] fRegionValue; fRegionValue = 0; + } //_____________________________________________________________________________ -THaAnalysisObject::EStatus THcCherenkov::Init( const TDatime& date ) -{ +THaAnalysisObject::EStatus THcCherenkov::Init(const TDatime& date) { // cout << "THcCherenkov::Init for: " << GetName() << endl; string EngineDID = string(GetApparatus()->GetName()).substr(0, 1) + GetName(); std::transform(EngineDID.begin(), EngineDID.end(), EngineDID.begin(), ::toupper); - if(gHcDetectorMap->FillMap(fDetMap, EngineDID.c_str()) < 0) { + if (gHcDetectorMap->FillMap(fDetMap, EngineDID.c_str()) < 0) { static const char* const here = "Init()"; Error(Here(here), "Error filling detectormap for %s.", EngineDID.c_str()); return kInitError; } EStatus status; - if((status = THaNonTrackingDetector::Init( date ))) - return fStatus=status; + if ((status = THaNonTrackingDetector::Init(date))) + return fStatus = status; // Should probably put this in ReadDatabase as we will know the // maximum number of hits after setting up the detector map - InitHitList(fDetMap, "THcCherenkovHit", fDetMap->GetTotNumChan()+1, - 0, fADC_RefTimeCut); + InitHitList(fDetMap, "THcCherenkovHit", fDetMap->GetTotNumChan() + 1, 0, fADC_RefTimeCut); - THcHallCSpectrometer *app=dynamic_cast<THcHallCSpectrometer*>(GetApparatus()); - if( !app || - !(fglHod = dynamic_cast<THcHodoscope*>(app->GetDetector("hod"))) ) { + THcHallCSpectrometer* app = dynamic_cast<THcHallCSpectrometer*>(GetApparatus()); + if (!app || !(fglHod = dynamic_cast<THcHodoscope*>(app->GetDetector("hod")))) { static const char* const here = "ReadDatabase()"; - Warning(Here(here),"Hodoscope \"%s\" not found. ","hod"); + Warning(Here(here), "Hodoscope \"%s\" not found. ", "hod"); } - fPresentP = 0; - THaVar* vpresent = gHaVars->Find(Form("%s.present",GetApparatus()->GetName())); - if(vpresent) { - fPresentP = (Bool_t *) vpresent->GetValuePointer(); + fPresentP = 0; + THaVar* vpresent = gHaVars->Find(Form("%s.present", GetApparatus()->GetName())); + if (vpresent) { + fPresentP = (Bool_t*)vpresent->GetValuePointer(); } return fStatus = kOK; } //_____________________________________________________________________________ -Int_t THcCherenkov::ReadDatabase( const TDatime& date ) -{ +Int_t THcCherenkov::ReadDatabase(const TDatime& date) { // This function is called by THaDetectorBase::Init() once at the beginning // of the analysis. @@ -192,34 +191,35 @@ Int_t THcCherenkov::ReadDatabase( const TDatime& date ) CreateMissReportParms(prefix.c_str()); - fNRegions = 4; // Defualt if not set in paramter file + fNRegions = 4; // Defualt if not set in paramter file - DBRequest list_1[] = { - {"_tot_pmts", &fNelem, kInt}, - {"_num_regions", &fNRegions, kInt}, - {0} - }; + DBRequest list_1[] = {{"_tot_pmts", &fNelem, kInt}, {"_num_regions", &fNRegions, kInt}, {0}}; gHcParms->LoadParmValues(list_1, prefix.c_str()); Bool_t optional = true; - cout << "Created Cherenkov detector " << GetApparatus()->GetName() << "." - << GetName() << " with " << fNelem << " PMTs" << endl; + _det_logger->info("Created Cherenkov detector {}.{} with {} PMTs", GetApparatus()->GetName(), + GetName(), fNelem); + // cout << "Created Cherenkov detector " << GetApparatus()->GetName() << "." + // << GetName() << " with " << fNelem << " PMTs" << endl; // 6 GeV pedestal paramters + fPedLimit = new Int_t[fNelem]; fGain = new Double_t[fNelem]; fPedMean = new Double_t[fNelem]; fAdcTimeWindowMin = new Double_t[fNelem]; fAdcTimeWindowMax= new Double_t[fNelem]; fPedDefault= new Int_t[fNelem]; + // Region parameters fRegionsValueMax = fNRegions * 8; fRegionValue = new Double_t[fRegionsValueMax]; fAdcGoodElem = new Int_t[fNelem]; fAdcPulseAmpTest = new Double_t[fNelem]; + DBRequest list[]={ {"_ped_limit", fPedLimit, kInt, (UInt_t) fNelem, optional}, {"_adc_to_npe", fGain, kDouble, (UInt_t) fNelem}, @@ -246,9 +246,10 @@ Int_t THcCherenkov::ReadDatabase( const TDatime& date ) fAdcTimeWindowMin[i]=-1000.; fAdcTimeWindowMax[i]=1000.; fPedDefault[i]=0; + } - fDebugAdc = 0; // Set ADC debug parameter to false unless set in parameter file - fAdcTdcOffset = 0.0; + fDebugAdc = 0; // Set ADC debug parameter to false unless set in parameter file + fAdcTdcOffset = 0.0; fADC_RefTimeCut = 0; gHcParms->LoadParmValues((DBRequest*)&list, prefix.c_str()); @@ -272,34 +273,34 @@ Int_t THcCherenkov::ReadDatabase( const TDatime& date ) } //_____________________________________________________________________________ -Int_t THcCherenkov::DefineVariables( EMode mode ) -{ +Int_t THcCherenkov::DefineVariables(EMode mode) { // Initialize global variables for histogramming and tree // cout << "THcCherenkov::DefineVariables called for: " << GetName() << endl; - if( mode == kDefine && fIsSetup ) return kOK; - fIsSetup = ( mode == kDefine ); + if (mode == kDefine && fIsSetup) + return kOK; + fIsSetup = (mode == kDefine); // Register variables in global list if (fDebugAdc) { RVarDef vars[] = { - {"numAdcHits", "Number of ADC Hits Per PMT", "fNumAdcHits"}, // Cherenkov occupancy - {"totNumAdcHits", "Total Number of ADC Hits", "fTotNumAdcHits"}, // Cherenkov multiplicity - {"adcPedRaw", "Raw ADC pedestals", "frAdcPedRaw.THcSignalHit.GetData()"}, - {"adcPulseIntRaw", "Raw ADC pulse integrals", "frAdcPulseIntRaw.THcSignalHit.GetData()"}, - {"adcPulseAmpRaw", "Raw ADC pulse amplitudes", "frAdcPulseAmpRaw.THcSignalHit.GetData()"}, - {"adcPulseTimeRaw", "Raw ADC pulse times", "frAdcPulseTimeRaw.THcSignalHit.GetData()"}, - {"adcPed", "ADC pedestals", "frAdcPed.THcSignalHit.GetData()"}, - {"adcPulseInt", "ADC pulse integrals", "frAdcPulseInt.THcSignalHit.GetData()"}, - {"adcPulseAmp", "ADC pulse amplitudes", "frAdcPulseAmp.THcSignalHit.GetData()"}, - {"adcPulseTime", "ADC pulse times", "frAdcPulseTime.THcSignalHit.GetData()"}, - { 0 } - }; - DefineVarsFromList( vars, mode); - } //end debug statement + {"numAdcHits", "Number of ADC Hits Per PMT", "fNumAdcHits"}, // Cherenkov occupancy + {"totNumAdcHits", "Total Number of ADC Hits", "fTotNumAdcHits"}, // Cherenkov multiplicity + {"adcPedRaw", "Raw ADC pedestals", "frAdcPedRaw.THcSignalHit.GetData()"}, + {"adcPulseIntRaw", "Raw ADC pulse integrals", "frAdcPulseIntRaw.THcSignalHit.GetData()"}, + {"adcPulseAmpRaw", "Raw ADC pulse amplitudes", "frAdcPulseAmpRaw.THcSignalHit.GetData()"}, + {"adcPulseTimeRaw", "Raw ADC pulse times", "frAdcPulseTimeRaw.THcSignalHit.GetData()"}, + {"adcPed", "ADC pedestals", "frAdcPed.THcSignalHit.GetData()"}, + {"adcPulseInt", "ADC pulse integrals", "frAdcPulseInt.THcSignalHit.GetData()"}, + {"adcPulseAmp", "ADC pulse amplitudes", "frAdcPulseAmp.THcSignalHit.GetData()"}, + {"adcPulseTime", "ADC pulse times", "frAdcPulseTime.THcSignalHit.GetData()"}, + {0}}; + DefineVarsFromList(vars, mode); + } // end debug statement RVarDef vars[] = { + {"adcCounter", "ADC counter numbers", "frAdcPulseIntRaw.THcSignalHit.GetPaddleNumber()"}, {"adcErrorFlag", "Error Flag for When FPGA Fails", "fAdcErrorFlag.THcSignalHit.GetData()"}, @@ -329,12 +330,31 @@ Int_t THcCherenkov::DefineVariables( EMode mode ) { 0 } }; + return DefineVarsFromList(vars, mode); } //_____________________________________________________________________________ -inline -void THcCherenkov::Clear(Option_t* opt) -{ + +Int_t THcCherenkov::ManualInitTree(TTree* t) { + // The most direct path to the output tree!!! + std::string app_name = GetApparatus()->GetName(); + std::string det_name = GetName(); + // if (t) { + // std::string branch_name = (app_name + "_" + det_name + "_data"); + // _det_logger->info("THcHodoscope::ManualInitTree : Adding branch, {}, to output tree", + // branch_name); t->Branch(branch_name.c_str(), &_basic_data, 32000, 99); + //} + if (t) { + std::string branch_name = (app_name + "_" + det_name + "_waveforms"); + _det_logger->info("THcCherenkov::ManualInitTree : Adding branch, {}, to output tree", + branch_name); + t->Branch(branch_name.c_str(), &_waveforms, 32000, 99); + } + return 0; +} +//_____________________________________________________________________________ + +void THcCherenkov::Clear(Option_t* opt) { // Clear the hit lists fNhits = 0; fTotNumAdcHits = 0; @@ -369,44 +389,50 @@ void THcCherenkov::Clear(Option_t* opt) fNumTracksFired.at(ielem) = 0; for (UInt_t ielem = 0; ielem < fGoodAdcPed.size(); ielem++) { fGoodAdcPed.at(ielem) = 0.0; - fGoodAdcMult.at(ielem) = 0.0; - fGoodAdcHitUsed.at(ielem) = 0.0; + fGoodAdcMult.at(ielem) = 0.0; + fGoodAdcHitUsed.at(ielem) = 0.0; fGoodAdcPulseInt.at(ielem) = 0.0; fGoodAdcPulseIntRaw.at(ielem) = 0.0; fGoodAdcPulseAmp.at(ielem) = 0.0; fGoodAdcPulseTime.at(ielem) = kBig; - fGoodAdcTdcDiffTime.at(ielem) = kBig; + fGoodAdcTdcDiffTime.at(ielem) = kBig; fNpe.at(ielem) = 0.0; } - + for(auto& wf : _waveforms) { + wf.ZeroBuffer(); + } } //_____________________________________________________________________________ -Int_t THcCherenkov::Decode( const THaEvData& evdata ) -{ + +Int_t THcCherenkov::Decode(const THaEvData& evdata) { // Get the Hall C style hitlist (fRawHitList) for this event - Bool_t present = kTRUE; // Suppress reference time warnings - if(fPresentP) { // if this spectrometer not part of trigger + Bool_t present = kTRUE; // Suppress reference time warnings + if (fPresentP) { // if this spectrometer not part of trigger present = *fPresentP; } fNhits = DecodeToHitList(evdata, !present); + //THcHallCSpectrometer *app = dynamic_cast<THcHallCSpectrometer*>(GetApparatus()); // cout << "Cerenkov Event num = " << evdata.GetEvNum() << " spec = " << app->GetName() << endl; if(gHaCuts->Result("Pedestal_event")) { + AccumulatePedestals(fRawHitList); - fAnalyzePedestals = 1; // Analyze pedestals first normal events - return(0); + fAnalyzePedestals = 1; // Analyze pedestals first normal events + return (0); } - if(fAnalyzePedestals) { + if (fAnalyzePedestals) { CalculatePedestals(); - fAnalyzePedestals = 0; // Don't analyze pedestals next event + fAnalyzePedestals = 0; // Don't analyze pedestals next event } Int_t ihit = 0; UInt_t nrAdcHits = 0; + _waveforms.clear(); + while(ihit < fNhits) { @@ -417,22 +443,31 @@ Int_t THcCherenkov::Decode( const THaEvData& evdata ) fRefTime=rawAdcHit.GetRefTime() ; } //if (rawAdcHit.GetNPulses()>0) cout << "Cer npmt = " << " ped = " << rawAdcHit.GetPed() << endl; + for (UInt_t thit = 0; thit < rawAdcHit.GetNPulses(); thit++) { - ((THcSignalHit*) frAdcPedRaw->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPedRaw()); - ((THcSignalHit*) frAdcPed->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPed()); + ((THcSignalHit*)frAdcPedRaw->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPedRaw()); + ((THcSignalHit*)frAdcPed->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPed()); - ((THcSignalHit*) frAdcPulseIntRaw->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPulseIntRaw(thit)); - ((THcSignalHit*) frAdcPulseInt->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPulseInt(thit)); + ((THcSignalHit*)frAdcPulseIntRaw->ConstructedAt(nrAdcHits)) + ->Set(npmt, rawAdcHit.GetPulseIntRaw(thit)); + ((THcSignalHit*)frAdcPulseInt->ConstructedAt(nrAdcHits)) + ->Set(npmt, rawAdcHit.GetPulseInt(thit)); - ((THcSignalHit*) frAdcPulseAmpRaw->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPulseAmpRaw(thit)); - ((THcSignalHit*) frAdcPulseAmp->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPulseAmp(thit)); + ((THcSignalHit*)frAdcPulseAmpRaw->ConstructedAt(nrAdcHits)) + ->Set(npmt, rawAdcHit.GetPulseAmpRaw(thit)); + ((THcSignalHit*)frAdcPulseAmp->ConstructedAt(nrAdcHits)) + ->Set(npmt, rawAdcHit.GetPulseAmp(thit)); - ((THcSignalHit*) frAdcPulseTimeRaw->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPulseTimeRaw(thit)); - ((THcSignalHit*) frAdcPulseTime->ConstructedAt(nrAdcHits))->Set(npmt, rawAdcHit.GetPulseTime(thit)+fAdcTdcOffset); + ((THcSignalHit*)frAdcPulseTimeRaw->ConstructedAt(nrAdcHits)) + ->Set(npmt, rawAdcHit.GetPulseTimeRaw(thit)); + ((THcSignalHit*)frAdcPulseTime->ConstructedAt(nrAdcHits)) + ->Set(npmt, rawAdcHit.GetPulseTime(thit) + fAdcTdcOffset); - if (rawAdcHit.GetPulseAmpRaw(thit) > 0) ((THcSignalHit*) fAdcErrorFlag->ConstructedAt(nrAdcHits))->Set(npmt, 0); - if (rawAdcHit.GetPulseAmpRaw(thit) <= 0) ((THcSignalHit*) fAdcErrorFlag->ConstructedAt(nrAdcHits))->Set(npmt, 1); + if (rawAdcHit.GetPulseAmpRaw(thit) > 0) + ((THcSignalHit*)fAdcErrorFlag->ConstructedAt(nrAdcHits))->Set(npmt, 0); + if (rawAdcHit.GetPulseAmpRaw(thit) <= 0) + ((THcSignalHit*)fAdcErrorFlag->ConstructedAt(nrAdcHits))->Set(npmt, 1); if (rawAdcHit.GetPulseAmpRaw(thit) <= 0) { Double_t PeakPedRatio= rawAdcHit.GetF250_PeakPedestalRatio(); @@ -453,7 +488,7 @@ Int_t THcCherenkov::Decode( const THaEvData& evdata ) ++nrAdcHits; fTotNumAdcHits++; - fNumAdcHits.at(npmt-1) = npmt; + fNumAdcHits.at(npmt - 1) = npmt; } ihit++; } @@ -461,14 +496,10 @@ Int_t THcCherenkov::Decode( const THaEvData& evdata ) } //_____________________________________________________________________________ -Int_t THcCherenkov::ApplyCorrections( void ) -{ - return(0); -} +Int_t THcCherenkov::ApplyCorrections(void) { return (0); } //_____________________________________________________________________________ -Int_t THcCherenkov::CoarseProcess( TClonesArray& ) -{ +Int_t THcCherenkov::CoarseProcess(TClonesArray&) { Double_t StartTime = 0.0; if( fglHod ) StartTime = fglHod->GetStartTime(); Double_t OffsetTime = 0.0; @@ -506,14 +537,16 @@ Int_t THcCherenkov::CoarseProcess( TClonesArray& ) Double_t pulseTime = ((THcSignalHit*) frAdcPulseTime->ConstructedAt(ielem))->GetData(); Double_t adctdcdiffTime = StartTime-pulseTime+OffsetTime; fGoodAdcPed.at(npmt) = pulsePed; - fGoodAdcHitUsed.at(npmt) = ielem+1; + fGoodAdcHitUsed.at(npmt) = ielem + 1; fGoodAdcPulseInt.at(npmt) = pulseInt; fGoodAdcPulseIntRaw.at(npmt) = pulseIntRaw; fGoodAdcPulseAmp.at(npmt) = pulseAmp; fGoodAdcPulseTime.at(npmt) = pulseTime; + fGoodAdcTdcDiffTime.at(npmt) = adctdcdiffTime; fNpe.at(npmt) = fGain[npmt]*pulseInt; + fNpeSum += fNpe.at(npmt); fTotNumGoodAdcHits++; @@ -524,83 +557,88 @@ Int_t THcCherenkov::CoarseProcess( TClonesArray& ) } //_____________________________________________________________________________ -Int_t THcCherenkov::FineProcess( TClonesArray& tracks ) -{ +Int_t THcCherenkov::FineProcess(TClonesArray& tracks) { Int_t nTracks = tracks.GetLast() + 1; for (Int_t itrack = 0; itrack < nTracks; itrack++) { - THaTrack* track = dynamic_cast<THaTrack*> (tracks[itrack]); - if (track->GetIndex() != 0) continue; // Select the best track + THaTrack* track = dynamic_cast<THaTrack*>(tracks[itrack]); + if (track->GetIndex() != 0) + continue; // Select the best track Double_t trackChi2 = track->GetChi2(); Int_t trackNDoF = track->GetNDoF(); - Double_t trackRedChi2 = trackChi2/trackNDoF; + Double_t trackRedChi2 = trackChi2 / trackNDoF; Double_t trackBeta = track->GetBeta(); Double_t trackEnergy = track->GetEnergy(); Double_t trackMom = track->GetP(); Double_t trackDp = track->GetDp(); - Double_t trackENorm = trackEnergy/trackMom; + Double_t trackENorm = trackEnergy / trackMom; Double_t trackXfp = track->GetX(); Double_t trackYfp = track->GetY(); Double_t trackTheta = track->GetTheta(); Double_t trackPhi = track->GetPhi(); Bool_t trackRedChi2Cut = trackRedChi2 > fRedChi2Min && trackRedChi2 < fRedChi2Max; - Bool_t trackBetaCut = trackBeta > fBetaMin && trackBeta < fBetaMax; - Bool_t trackENormCut = trackENorm > fENormMin && trackENorm < fENormMax; - Bool_t trackDpCut = trackDp > fDpMin && trackDp < fDpMax; - fXAtCer = trackXfp + trackTheta * fMirrorZPos; - fYAtCer = trackYfp + trackPhi * fMirrorZPos; + Bool_t trackBetaCut = trackBeta > fBetaMin && trackBeta < fBetaMax; + Bool_t trackENormCut = trackENorm > fENormMin && trackENorm < fENormMax; + Bool_t trackDpCut = trackDp > fDpMin && trackDp < fDpMax; + fXAtCer = trackXfp + trackTheta * fMirrorZPos; + fYAtCer = trackYfp + trackPhi * fMirrorZPos; if (trackRedChi2Cut && trackBetaCut && trackENormCut && trackDpCut) { - // Project the track to the Cherenkov mirror planes - - // cout << "Cherenkov Detector: " << GetName() << " has fNRegions = " << fNRegions << endl; - // cout << "nTracks = " << nTracks << "\t" << "trackChi2 = " << trackChi2 - // << "\t" << "trackNDof = " << trackNDoF << "\t" << "trackRedChi2 = " << trackRedChi2 << endl; - // cout << "trackBeta = " << trackBeta << "\t" << "trackEnergy = " << trackEnergy << "\t" - // << "trackMom = " << trackMom << "\t" << "trackENorm = " << trackENorm << endl; - // cout << "trackXfp = " << trackXfp << "\t" << "trackYfp = " << trackYfp << "\t" - // << "trackTheta = " << trackTheta << "\t" << "trackPhi = " << trackPhi << endl; - // cout << "fMirrorZPos = " << fMirrorZPos << "\t" << "fXAtCer = " << fXAtCer << "\t" << "fYAtCer = " << fYAtCer << endl; - // cout << "=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:" << endl; - - for (Int_t iregion = 0; iregion < fNRegions; iregion++) { - - if ((TMath::Abs(fRegionValue[GetIndex(iregion, 0)] - fXAtCer) < fRegionValue[GetIndex(iregion, 4)]) && - (TMath::Abs(fRegionValue[GetIndex(iregion, 1)] - fYAtCer) < fRegionValue[GetIndex(iregion, 5)]) && - (TMath::Abs(fRegionValue[GetIndex(iregion, 2)] - trackTheta) < fRegionValue[GetIndex(iregion, 6)]) && - (TMath::Abs(fRegionValue[GetIndex(iregion, 3)] - trackPhi) < fRegionValue[GetIndex(iregion, 7)])) { - - fTotNumTracksMatched++; - fNumTracksMatched.at(iregion) = iregion + 1; - - if (fNpeSum > fNpeThresh) { - fTotNumTracksFired++; - fNumTracksFired.at(iregion) = iregion + 1; - } // NPE threshold cut - } // Regional cuts - } // Loop over regions - } // Tracking cuts - } // Track loop + // Project the track to the Cherenkov mirror planes + + // cout << "Cherenkov Detector: " << GetName() << " has fNRegions = " << fNRegions << endl; + // cout << "nTracks = " << nTracks << "\t" << "trackChi2 = " << trackChi2 + // << "\t" << "trackNDof = " << trackNDoF << "\t" << "trackRedChi2 = " << + // trackRedChi2 << endl; cout << "trackBeta = " << trackBeta << "\t" << "trackEnergy = " << + // trackEnergy << "\t" + // << "trackMom = " << trackMom << "\t" << "trackENorm = " << trackENorm << endl; + // cout << "trackXfp = " << trackXfp << "\t" << "trackYfp = " << trackYfp << "\t" + // << "trackTheta = " << trackTheta << "\t" << "trackPhi = " << trackPhi << endl; + // cout << "fMirrorZPos = " << fMirrorZPos << "\t" << "fXAtCer = " << fXAtCer << "\t" << + // "fYAtCer = " << fYAtCer << endl; cout << + // "=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:" << endl; + + for (Int_t iregion = 0; iregion < fNRegions; iregion++) { + + if ((TMath::Abs(fRegionValue[GetIndex(iregion, 0)] - fXAtCer) < + fRegionValue[GetIndex(iregion, 4)]) && + (TMath::Abs(fRegionValue[GetIndex(iregion, 1)] - fYAtCer) < + fRegionValue[GetIndex(iregion, 5)]) && + (TMath::Abs(fRegionValue[GetIndex(iregion, 2)] - trackTheta) < + fRegionValue[GetIndex(iregion, 6)]) && + (TMath::Abs(fRegionValue[GetIndex(iregion, 3)] - trackPhi) < + fRegionValue[GetIndex(iregion, 7)])) { + + fTotNumTracksMatched++; + fNumTracksMatched.at(iregion) = iregion + 1; + + if (fNpeSum > fNpeThresh) { + fTotNumTracksFired++; + fNumTracksFired.at(iregion) = iregion + 1; + } // NPE threshold cut + } // Regional cuts + } // Loop over regions + } // Tracking cuts + } // Track loop return 0; } //_____________________________________________________________________________ -void THcCherenkov::InitializePedestals() -{ +void THcCherenkov::InitializePedestals() { fNPedestalEvents = 0; - fMinPeds = 500; // In engine, this is set in parameter file - fPedSum = new Int_t [fNelem]; - fPedSum2 = new Int_t [fNelem]; - fPedCount = new Int_t [fNelem]; - fPed = new Double_t [fNelem]; - fThresh = new Double_t [fNelem]; - for(Int_t i = 0; i < fNelem; i++) { + fMinPeds = 500; // In engine, this is set in parameter file + fPedSum = new Int_t[fNelem]; + fPedSum2 = new Int_t[fNelem]; + fPedCount = new Int_t[fNelem]; + fPed = new Double_t[fNelem]; + fThresh = new Double_t[fNelem]; + for (Int_t i = 0; i < fNelem; i++) { fPedSum[i] = 0; fPedSum2[i] = 0; fPedCount[i] = 0; @@ -608,25 +646,24 @@ void THcCherenkov::InitializePedestals() } //_____________________________________________________________________________ -void THcCherenkov::AccumulatePedestals(TClonesArray* rawhits) -{ +void THcCherenkov::AccumulatePedestals(TClonesArray* rawhits) { // Extract data from the hit list, accumulating into arrays for // calculating pedestals - Int_t nrawhits = rawhits->GetLast()+1; + Int_t nrawhits = rawhits->GetLast() + 1; Int_t ihit = 0; - while(ihit < nrawhits) { - THcCherenkovHit* hit = (THcCherenkovHit *) rawhits->At(ihit); + while (ihit < nrawhits) { + THcCherenkovHit* hit = (THcCherenkovHit*)rawhits->At(ihit); Int_t element = hit->fCounter - 1; - Int_t nadc = hit->GetRawAdcHitPos().GetPulseIntRaw(); - if(nadc <= fPedLimit[element]) { - fPedSum[element] += nadc; - fPedSum2[element] += nadc*nadc; + Int_t nadc = hit->GetRawAdcHitPos().GetPulseIntRaw(); + if (nadc <= fPedLimit[element]) { + fPedSum[element] += nadc; + fPedSum2[element] += nadc * nadc; fPedCount[element]++; - if(fPedCount[element] == fMinPeds/5) { - fPedLimit[element] = 100 + fPedSum[element]/fPedCount[element]; + if (fPedCount[element] == fMinPeds / 5) { + fPedLimit[element] = 100 + fPedSum[element] / fPedCount[element]; } } ihit++; @@ -638,62 +675,51 @@ void THcCherenkov::AccumulatePedestals(TClonesArray* rawhits) } //_____________________________________________________________________________ -void THcCherenkov::CalculatePedestals() -{ +void THcCherenkov::CalculatePedestals() { // Use the accumulated pedestal data to calculate pedestals // Later add check to see if pedestals have drifted ("Danger Will Robinson!") // cout << "Plane: " << fPlaneNum << endl; - for(Int_t i=0; i<fNelem;i++) { + for (Int_t i = 0; i < fNelem; i++) { // PMT tubes - fPed[i] = ((Double_t) fPedSum[i]) / TMath::Max(1, fPedCount[i]); + fPed[i] = ((Double_t)fPedSum[i]) / TMath::Max(1, fPedCount[i]); fThresh[i] = fPed[i] + 15; // Just a copy for now, but allow the possibility that fXXXPedMean is set // in a parameter file and only overwritten if there is a sufficient number of // pedestal events. (So that pedestals are sensible even if the pedestal events were // not acquired.) - if(fMinPeds > 0) { - if(fPedCount[i] > fMinPeds) { - fPedMean[i] = fPed[i]; + if (fMinPeds > 0) { + if (fPedCount[i] > fMinPeds) { + fPedMean[i] = fPed[i]; } } } // cout << " " << endl; - } //_____________________________________________________________________________ -Int_t THcCherenkov::GetIndex(Int_t nRegion, Int_t nValue) -{ - return fNRegions * nValue + nRegion; -} - +Int_t THcCherenkov::GetIndex(Int_t nRegion, Int_t nValue) { return fNRegions * nValue + nRegion; } //_____________________________________________________________________________ -void THcCherenkov::Print(const Option_t* opt) const -{ +void THcCherenkov::Print(const Option_t* opt) const { THaNonTrackingDetector::Print(opt); // Print out the pedestals cout << endl; cout << "Cherenkov Pedestals" << endl; // Ahmed cout << "No. ADC" << endl; - for(Int_t i=0; i<fNelem; i++) + for (Int_t i = 0; i < fNelem; i++) cout << " " << i << " " << fPed[i] << endl; cout << endl; } //_____________________________________________________________________________ -Double_t THcCherenkov::GetCerNPE() -{ - return fNpeSum; -} +Double_t THcCherenkov::GetCerNPE() { return fNpeSum; } //_____________________________________________________________________________ -Int_t THcCherenkov::End(THaRunBase* run) -{ +Int_t THcCherenkov::End(THaRunBase* run) { MissReport(Form("%s.%s", GetApparatus()->GetName(), GetName())); return 0; } ClassImp(THcCherenkov) -//////////////////////////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////////////////////////// diff --git a/src/THcCherenkov.h b/src/THcCherenkov.h index 63136fdb13ee892337ab45f7f2e24cd4c322402d..446101f10f83b3e11d4eb8ac7814b11b55b45db1 100644 --- a/src/THcCherenkov.h +++ b/src/THcCherenkov.h @@ -11,9 +11,18 @@ #include "THaNonTrackingDetector.h" #include "THcHitList.h" #include "THcCherenkovHit.h" + +#include "hcana/Logger.h" +#include "hcana/HallC_Data.h" + class THcHodoscope; class THcCherenkov : public THaNonTrackingDetector, public THcHitList { +public: + + std::vector<hallc::data::PulseWaveForm> _waveforms; + + using vec = std::vector<Double_t>; public: THcCherenkov(const char* name, const char* description = "", THaApparatus* a = NULL); @@ -26,6 +35,7 @@ class THcCherenkov : public THaNonTrackingDetector, public THcHitList { virtual Int_t Decode(const THaEvData&); virtual Int_t ReadDatabase(const TDatime& date); virtual Int_t DefineVariables(EMode mode = kDefine); + virtual Int_t ManualInitTree( TTree* t ); virtual Int_t CoarseProcess(TClonesArray& tracks); virtual Int_t FineProcess(TClonesArray& tracks); virtual Int_t ApplyCorrections( void ); @@ -45,6 +55,7 @@ class THcCherenkov : public THaNonTrackingDetector, public THcHitList { static const Int_t MaxNumAdcPulse = 4; THcCherenkov(); // for ROOT I/O + protected: Bool_t* fPresentP; Int_t fAnalyzePedestals; @@ -66,15 +77,15 @@ class THcCherenkov : public THaNonTrackingDetector, public THcHitList { vector<Int_t> fNumGoodAdcHits; vector<Int_t> fNumTracksMatched; vector<Int_t> fNumTracksFired; - vector<Double_t> fGoodAdcPed; - vector<Double_t> fGoodAdcMult; - vector<Double_t> fGoodAdcHitUsed; - vector<Double_t> fGoodAdcPulseInt; - vector<Double_t> fGoodAdcPulseIntRaw; - vector<Double_t> fGoodAdcPulseAmp; - vector<Double_t> fGoodAdcPulseTime; - vector<Double_t> fGoodAdcTdcDiffTime; - vector<Double_t> fNpe; + vec fGoodAdcPed; + vec fGoodAdcMult; + vec fGoodAdcHitUsed; + vec fGoodAdcPulseInt; + vec fGoodAdcPulseIntRaw; + vec fGoodAdcPulseAmp; + vec fGoodAdcPulseTime; + vec fGoodAdcTdcDiffTime; + vec fNpe; Int_t fNRegions; Int_t fRegionsValueMax; diff --git a/src/THcCherenkovHit.h b/src/THcCherenkovHit.h index bf969626ac4964299dc20ddde0d28d56ce796000..c586bc4ba46dcb7d8f09121b22d4a459e2c20ef6 100644 --- a/src/THcCherenkovHit.h +++ b/src/THcCherenkovHit.h @@ -8,10 +8,6 @@ class THcCherenkovHit : public THcRawHodoHit { public: friend class THcCherenkov; - protected: - - private: - ClassDef(THcCherenkovHit,0); // Raw Cherenkov hit }; diff --git a/src/THcCoinTime.cxx b/src/THcCoinTime.cxx index 207e8a4d9d09e93efcbb9c6b3c6a075c2ec89e03..84546108ec241ffc2d0c6ff1b7d5325c9995a454 100644 --- a/src/THcCoinTime.cxx +++ b/src/THcCoinTime.cxx @@ -30,7 +30,7 @@ using namespace std; THcCoinTime::THcCoinTime (const char *name, const char* description, const char* hadArmName, const char* elecArmName, const char* coinname) : - THaPhysicsModule(name, description), + hcana::ConfigLogging<THaPhysicsModule>(name, description), fCoinDetName(coinname), fhadArmName(hadArmName), //initialize spectro names felecArmName(elecArmName), @@ -88,19 +88,27 @@ THaAnalysisObject::EStatus THcCoinTime::Init( const TDatime& run_time ) { // Initialize THcCoinTime physics module - cout << "*************************************************" << endl; - cout << "Initializing THcCointTime Physics Modue" << endl; - cout << "Hadron Arm -------> " << fhadArmName << endl; - cout << "Electron Arm -------> " << felecArmName << endl; - cout << "TrigDet -------> " << fCoinDetName << endl; - cout << "**************************************************" << endl; + //cout << "*************************************************" << endl; + //cout << "Initializing THcCointTime Physics Modue" << endl; + //cout << "Hadron Arm -------> " << fhadArmName << endl; + //cout << "Electron Arm -------> " << felecArmName << endl; + //cout << "TrigDet -------> " << fCoinDetName << endl; + //cout << "**************************************************" << endl; + + _logger->info("*************************************************"); + _logger->info("Initializing THcCointTime Physics Modue" ); + _logger->info("Hadron Arm -------> {}" , fhadArmName.Data() ); + _logger->info("Electron Arm -------> {}" , felecArmName.Data() ); + _logger->info("TrigDet -------> {}" , fCoinDetName.Data() ); + _logger->info("**************************************************" ); fStatus = kOK; fhadSpectro = dynamic_cast<THcHallCSpectrometer*> ( FindModule( fhadArmName.Data(), "THcHallCSpectrometer")); if( !fhadSpectro ) { - cout << "THcCoinTime module Cannnot find Hadron Arm = " << fhadArmName.Data() << endl; + //cout << "THcCoinTime module Cannnot find Hadron Arm = " << fhadArmName.Data() << endl; + _logger->error("THcCoinTime module Cannnot find Hadron Arm = {}" , fhadArmName.Data()); fStatus = kInitError; return fStatus; } @@ -108,7 +116,8 @@ THaAnalysisObject::EStatus THcCoinTime::Init( const TDatime& run_time ) felecSpectro = dynamic_cast<THcHallCSpectrometer*> ( FindModule( felecArmName.Data(), "THcHallCSpectrometer")); if( !felecSpectro ) { - cout << "THcCoinTime module Cannnot find Electron Arm = " << felecArmName.Data() << endl; + //cout << "THcCoinTime module Cannnot find Electron Arm = " << felecArmName.Data() << endl; + _logger->error("THcCoinTime module Cannnot find Electron Arm = {}" , felecArmName.Data()); fStatus = kInitError; return fStatus; } @@ -116,7 +125,8 @@ THaAnalysisObject::EStatus THcCoinTime::Init( const TDatime& run_time ) fCoinDet = dynamic_cast<THcTrigDet*> ( FindModule( fCoinDetName.Data(), "THcTrigDet")); if( !fCoinDet ) { - cout << "THcCoinTime module Cannnot find TrigDet = " << fCoinDetName.Data() << endl; + //cout << "THcCoinTime module Cannnot find TrigDet = " << fCoinDetName.Data() << endl; + _logger->error("THcCoinTime module Cannnot find TrigDet = {}", fCoinDetName.Data()); fStatus = kInitError; return fStatus; } diff --git a/src/THcCoinTime.h b/src/THcCoinTime.h index 856362782da758ea7d7cc7bb9120bd6511c76096..ecaf5008c6365d9c317deaa3a28b32ab583826f9 100644 --- a/src/THcCoinTime.h +++ b/src/THcCoinTime.h @@ -26,7 +26,9 @@ #include "THcHallCSpectrometer.h" #include "THaTrack.h" -class THcCoinTime : public THaPhysicsModule { +#include "hcana/Logger.h" + +class THcCoinTime : public hcana::ConfigLogging<THaPhysicsModule> { public: THcCoinTime( const char* name, const char* description, const char* hadArmName="", const char* elecArmName="", const char* coinname=""); diff --git a/src/THcConfigEvtHandler.cxx b/src/THcConfigEvtHandler.cxx index 1ecb3e754bd06421bac06435eb64a37577cd2711..a3cc6bc144773d7a58aea12ee0d4266fd0f33608 100644 --- a/src/THcConfigEvtHandler.cxx +++ b/src/THcConfigEvtHandler.cxx @@ -31,11 +31,14 @@ #include <cstdlib> #include <iostream> #include <iomanip> +#include "spdlog/spdlog.h" +#include "spdlog/sinks/stdout_color_sinks.h" //support for stdout logging +#include "spdlog/sinks/basic_file_sink.h" // support for basic file logging using namespace std; THcConfigEvtHandler::THcConfigEvtHandler(const char *name, const char* description) - : THaEvtTypeHandler(name,description) + : hcana::ConfigLogging<THaEvtTypeHandler>(name,description) { } @@ -82,14 +85,18 @@ Int_t THcConfigEvtHandler::Analyze(THaEvData *evdata) if ( !IsMyEvent(evdata->GetEvType()) ) return -1; - if (ldebug) cout << "------------------\n Event type 125"<<endl; + if (ldebug){ + //cout << "------------------\n Event type 125"<<endl; + } + _logger->debug("--- Event type 125 ---"); Int_t evlen = evdata->GetEvLength(); Int_t ip = 0; ip++; UInt_t thisword = evdata->GetRawData(ip); Int_t roc = thisword & 0xff; - cout << "THcConfigEvtHandler: " << roc << endl; + _logger->info("THcConfigEvtHandler: {} ", roc); + //cout << "THcConfigEvtHandler: " << roc << endl; // Should check if this roc has already been seen CrateInfo_t *cinfo = new CrateInfo_t; cinfo->FADC250.nmodules=0; @@ -108,12 +115,15 @@ Int_t THcConfigEvtHandler::Analyze(THaEvData *evdata) if (thisword == 0xdafadcff) { ip++; thisword = evdata->GetRawData(ip); - cout << "ADC thresholds for slots "; + std::string adc_th_string; + //cout << "ADC thresholds for slots "; while((thisword & 0xfffff000)==0xfadcf000) { Int_t slot = thisword&0x1f; // Should check if this slot has already been SDC_WIRE_CENTER cinfo->FADC250.nmodules++; - cout << " " << slot; + //cout << " " << slot; + adc_th_string += std::string(" "); + adc_th_string += std::to_string(slot); Int_t *thresholds = new Int_t [16]; cinfo->FADC250.thresholds.insert(std::make_pair(slot, thresholds)); for(Int_t i=0;i<16;i++) { @@ -122,15 +132,18 @@ Int_t THcConfigEvtHandler::Analyze(THaEvData *evdata) ip +=18; if(ip>=evlen) { if(ip>evlen) { - cout << endl << "Info event truncated" << endl; + //cout << endl << "Info event truncated" << endl; + adc_th_string += std::string(" ... truncated "); } break; } thisword = evdata->GetRawData(ip); } - cout << endl; + //cout << endl; + _logger->info("ADC thresholds for slots {}", adc_th_string); } else if((thisword&0xffffff00) == 0xdafadc00) { // FADC250 information - cout << "ADC information: Block level " << (thisword&0xff) << endl; + //cout << "ADC information: Block level " << (thisword&0xff) << endl; + _logger->info("ADC information: Block level {} " , (thisword&0xff)); cinfo->FADC250.present = 1; cinfo->FADC250.blocklevel = thisword&0xff; cinfo->FADC250.dac_level = evdata->GetRawData(ip+2); @@ -146,7 +159,8 @@ Int_t THcConfigEvtHandler::Analyze(THaEvData *evdata) cinfo->FADC250.nsat = evdata->GetRawData(ip+12); ip += 13; } else if (thisword == 0xdedc1190) { // CAEN 1190 information - cout << "TDC information" << endl; + //cout << "TDC information" << endl; + _logger->info("TDC information"); cinfo->CAEN1190.present = 1; cinfo->CAEN1190.resolution = evdata->GetRawData(ip+2); cinfo->CAEN1190.timewindow_offset = evdata->GetRawData(ip+3); @@ -187,7 +201,8 @@ Int_t THcConfigEvtHandler::Analyze(THaEvData *evdata) } } - cout << "Making Parms for ROC " << roc << " Event type " << evdata->GetEvType() << endl; + //cout << "Making Parms for ROC " << roc << " Event type " << evdata->GetEvType() << endl; + _logger->info("Making Parms for ROC {} Event type ", roc, evdata->GetEvType()); MakeParms(roc); return 1; @@ -378,7 +393,7 @@ void THcConfigEvtHandler::AddEventType(Int_t evtype) THaAnalysisObject::EStatus THcConfigEvtHandler::Init(const TDatime& date) { - cout << "Howdy ! We are initializing THcConfigEvtHandler !! name = "<<fName<<endl; + _logger->info("Howdy ! We are initializing THcConfigEvtHandler !! name = {}",fName.Data()); if(eventtypes.size()==0) { eventtypes.push_back(125); // what events to look for diff --git a/src/THcConfigEvtHandler.h b/src/THcConfigEvtHandler.h index e62ece45ec1ddf49db72c345a75898bfb5760144..5712b4ea042f66d948e009b4dacc50c53b2d0e7e 100644 --- a/src/THcConfigEvtHandler.h +++ b/src/THcConfigEvtHandler.h @@ -15,7 +15,9 @@ #include <vector> #include <map> -class THcConfigEvtHandler : public THaEvtTypeHandler { +#include "hcana/Logger.h" + +class THcConfigEvtHandler : public hcana::ConfigLogging<THaEvtTypeHandler> { public: diff --git a/src/THcDC.cxx b/src/THcDC.cxx index 37efbb342a365f54dc3ed02057011043d73906ed..cad4ce981b7c215429cd365a0d45ff1813bb43fb 100644 --- a/src/THcDC.cxx +++ b/src/THcDC.cxx @@ -13,240 +13,247 @@ the number of parameters per plane. */ #include "THcDC.h" -#include "THaEvData.h" +#include "TClonesArray.h" +#include "THaApparatus.h" +#include "THaCutList.h" #include "THaDetMap.h" +#include "THaEvData.h" +#include "THaTrack.h" +#include "THcDCTrack.h" #include "THcDetectorMap.h" #include "THcGlobals.h" -#include "THaCutList.h" +#include "THcHallCSpectrometer.h" #include "THcParmList.h" -#include "THcDCTrack.h" -#include "VarDef.h" -#include "VarType.h" -#include "THaTrack.h" -#include "TClonesArray.h" #include "TMath.h" #include "TVectorD.h" -#include "THaApparatus.h" -#include "THcHallCSpectrometer.h" +#include "VarDef.h" +#include "VarType.h" -#include <cstring> #include <cstdio> #include <cstdlib> +#include <cstring> #include <iostream> +#include "spdlog/sinks/basic_file_sink.h" // support for basic file logging +#include "spdlog/sinks/stdout_color_sinks.h" //support for stdout logging +#include "spdlog/spdlog.h" + using namespace std; //_____________________________________________________________________________ -THcDC::THcDC( - const char* name, const char* description, - THaApparatus* apparatus ) : - THaTrackingDetector(name,description,apparatus) -{ +THcDC::THcDC(const char* name, const char* description, THaApparatus* apparatus) + : THaTrackingDetector(name, description, apparatus) { // Constructor - fNPlanes = 0; // No planes until we make them - - fXCenter = NULL; - fYCenter = NULL; - fMinHits = NULL; - fMaxHits = NULL; - fMinCombos = NULL; + fNPlanes = 0; // No planes until we make them + _sub_logger = _det_logger->clone("THcDC"); + fXCenter = NULL; + fYCenter = NULL; + fMinHits = NULL; + fMaxHits = NULL; + fMinCombos = NULL; fSpace_Point_Criterion = NULL; - fTdcWinMin = NULL; - fTdcWinMax = NULL; - fCentralTime = NULL; - fNWires = NULL; - fNChamber = NULL; - fWireOrder = NULL; + fTdcWinMin = NULL; + fTdcWinMax = NULL; + fCentralTime = NULL; + fNWires = NULL; + fNChamber = NULL; + fWireOrder = NULL; fDriftTimeSign = NULL; - fReadoutTB = NULL; - fReadoutLR = NULL; - - fXPos = NULL; - fYPos = NULL; - fZPos = NULL; - fAlphaAngle = NULL; - fBetaAngle = NULL; - fGammaAngle = NULL; - fPitch = NULL; - fCentralWire = NULL; + fReadoutTB = NULL; + fReadoutLR = NULL; + + fXPos = NULL; + fYPos = NULL; + fZPos = NULL; + fAlphaAngle = NULL; + fBetaAngle = NULL; + fGammaAngle = NULL; + fPitch = NULL; + fCentralWire = NULL; fPlaneTimeZero = NULL; - fSigma = NULL; + fSigma = NULL; // These should be set to zero (in a parameter file) in order to // replicate historical ENGINE behavior - fFixLR = 1; + fFixLR = 1; fFixPropagationCorrection = 1; - fProjectToChamber = 0; // Use 1 for SOS chambers + fProjectToChamber = 0; // Use 1 for SOS chambers - fDCTracks = new TClonesArray( "THcDCTrack", 20 ); + fDCTracks = new TClonesArray("THcDCTrack", 20); - fNChamHits = 0; + fNChamHits = 0; fPlaneEvents = 0; - //The version defaults to 0 (old HMS style). 1 is new HMS style and 2 is SHMS style. + // The version defaults to 0 (old HMS style). 1 is new HMS style and 2 is SHMS style. fVersion = 0; + + // Create and return a shared_ptr to a multithreaded console logger. + //_logger = spdlog::get("config"); + // if(!_logger) { + // _logger = spdlog::stdout_color_mt("config"); + //} + _sub_logger->debug("THcDC constructor"); } //_____________________________________________________________________________ -void THcDC::Setup(const char* name, const char* description) -{ +void THcDC::Setup(const char* name, const char* description) { - Bool_t optional = true; + Bool_t optional = true; // Create the chamber and plane objects using parameters. static const char* const here = "Setup"; - THaApparatus *app = GetApparatus(); - if(app) { + THaApparatus* app = GetApparatus(); + if (app) { // cout << app->GetName() << endl; - fPrefix[0]=tolower(app->GetName()[0]); - fPrefix[1]='\0'; + fPrefix[0] = tolower(app->GetName()[0]); + fPrefix[1] = '\0'; } else { cout << "No apparatus found" << endl; - fPrefix[0]='\0'; + fPrefix[0] = '\0'; } // For now, decide chamber style from the spectrometer name. // Should override with a paramter - //cout<<"HMS Style??\t"<<fHMSStyleChambers<<endl; - string planenamelist; - DBRequest list[]={ - {"dc_num_planes",&fNPlanes, kInt}, - {"dc_num_chambers",&fNChambers, kInt}, - {"dc_tdc_time_per_channel",&fNSperChan, kDouble}, - {"dc_wire_velocity",&fWireVelocity,kDouble}, - {"dc_plane_names",&planenamelist, kString}, - {"dc_version", &fVersion, kInt, 0, optional}, - {"dc_tdcrefcut", &fTDC_RefTimeCut, kInt, 0, 1}, - {0} - }; - - fTDC_RefTimeCut = 0; // Minimum allowed reference times - gHcParms->LoadParmValues((DBRequest*)&list,fPrefix); - - if(fVersion==0) { + // cout<<"HMS Style??\t"<<fHMSStyleChambers<<endl; + string planenamelist; + DBRequest list[] = {{"dc_num_planes", &fNPlanes, kInt}, + {"dc_num_chambers", &fNChambers, kInt}, + {"dc_tdc_time_per_channel", &fNSperChan, kDouble}, + {"dc_wire_velocity", &fWireVelocity, kDouble}, + {"dc_plane_names", &planenamelist, kString}, + {"dc_version", &fVersion, kInt, 0, optional}, + {"dc_tdcrefcut", &fTDC_RefTimeCut, kInt, 0, 1}, + {0}}; + + fTDC_RefTimeCut = 0; // Minimum allowed reference times + gHcParms->LoadParmValues((DBRequest*)&list, fPrefix); + + if (fVersion == 0) { fHMSStyleChambers = 1; } else { fHMSStyleChambers = 0; } - - cout << "Plane Name List: " << planenamelist << endl; - cout << "Drift Chambers: " << fNPlanes << " planes in " << fNChambers << " chambers" << endl; + _det_logger->info("Plane Name List: {}", planenamelist); + _det_logger->info("Drift Chambers: {} planes in {} chambers", fNPlanes, fNChambers); + // cout << "Plane Name List: " << planenamelist << endl; + // cout << "Drift Chambers: " << fNPlanes << " planes in " << fNChambers << " chambers" << endl; vector<string> plane_names = vsplit(planenamelist); - if(plane_names.size() != (UInt_t) fNPlanes) { - cout << "ERROR: Number of planes " << fNPlanes << " doesn't agree with number of plane names " << plane_names.size() << endl; + if (plane_names.size() != (UInt_t)fNPlanes) { + // cout << "ERROR: Number of planes " << fNPlanes << " doesn't agree with number of plane names + // " << plane_names.size() << endl; + _det_logger->error("ERROR: Number of planes {} doesn't agree with number of plane names {}", + fNPlanes, plane_names.size()); + // Should quit. Is there an official way to quit? } - fPlaneNames = new char* [fNPlanes]; - for(Int_t i=0;i<fNPlanes;i++) { - fPlaneNames[i] = new char[plane_names[i].length()+1]; + fPlaneNames = new char*[fNPlanes]; + for (Int_t i = 0; i < fNPlanes; i++) { + fPlaneNames[i] = new char[plane_names[i].length() + 1]; strcpy(fPlaneNames[i], plane_names[i].c_str()); } - char *desc = new char[strlen(description)+100]; - char *desc1= new char[strlen(description)+100]; + char* desc = new char[strlen(description) + 100]; + char* desc1 = new char[strlen(description) + 100]; fPlanes.clear(); - for(Int_t i=0;i<fNPlanes;i++) { + for (Int_t i = 0; i < fNPlanes; i++) { strcpy(desc, description); strcat(desc, " Plane "); strcat(desc, fPlaneNames[i]); - THcDriftChamberPlane* newplane = new THcDriftChamberPlane(fPlaneNames[i], desc, i+1, this); - if( !newplane or newplane->IsZombie() ) { - Error( Here(here), "Error creating Drift Chamber plane %s. Call expert.", name); + THcDriftChamberPlane* newplane = new THcDriftChamberPlane(fPlaneNames[i], desc, i + 1, this); + if (!newplane or newplane->IsZombie()) { + _det_logger->error("{} Error creating Drift Chamber plane {}. Call expert.", Here(here), + name); MakeZombie(); - delete [] desc; - delete [] desc1; + delete[] desc; + delete[] desc1; return; } fPlanes.push_back(newplane); newplane->SetDebug(fDebug); // cout << "Created Drift Chamber Plane " << fPlaneNames[i] << ", " << desc << endl; - } fChambers.clear(); - for(UInt_t i=0;i<fNChambers;i++) { - sprintf(desc1,"Ch%d",i+1); + for (UInt_t i = 0; i < fNChambers; i++) { + sprintf(desc1, "Ch%d", i + 1); // Should construct a better chamber name - THcDriftChamber* newchamber = new THcDriftChamber(desc1, desc, i+1, this); + THcDriftChamber* newchamber = new THcDriftChamber(desc1, desc, i + 1, this); fChambers.push_back(newchamber); - cout << "Created Drift Chamber " << i+1 << ", " << desc1 << endl; + // cout << "Created Drift Chamber " << i+1 << ", " << desc1 << endl; + _det_logger->info("Created Drift Chamber {}, {}", i + 1, desc1); newchamber->SetHMSStyleFlag(fHMSStyleChambers); // Tell the chamber its style } - delete [] desc; - delete [] desc1; + delete[] desc; + delete[] desc1; } //_____________________________________________________________________________ -THcDC::THcDC( ) : - THaTrackingDetector() -{ +THcDC::THcDC() { // Constructor } //_____________________________________________________________________________ -THaAnalysisObject::EStatus THcDC::Init( const TDatime& date ) -{ +THaAnalysisObject::EStatus THcDC::Init(const TDatime& date) { // Register the plane objects with the appropriate chambers. // Trigger ReadDatabase to load the remaining parameters - Setup(GetName(), GetTitle()); // Create the subdetectors here + Setup(GetName(), GetTitle()); // Create the subdetectors here EffInit(); char EngineDID[] = "xDC"; - EngineDID[0] = toupper(GetApparatus()->GetName()[0]); - if( gHcDetectorMap->FillMap(fDetMap, EngineDID) < 0 ) { + EngineDID[0] = toupper(GetApparatus()->GetName()[0]); + if (gHcDetectorMap->FillMap(fDetMap, EngineDID) < 0) { static const char* const here = "Init()"; - Error( Here(here), "Error filling detectormap for %s.", EngineDID ); + _det_logger->error("{} Error filling detectormap for {}.", Here(here), EngineDID); return kInitError; } // Should probably put this in ReadDatabase as we will know the // maximum number of hits after setting up the detector map - cout << " DC tdc ref time cut = " << fTDC_RefTimeCut << endl; - InitHitList(fDetMap, "THcRawDCHit", fDetMap->GetTotNumChan()+1, - fTDC_RefTimeCut, 0); + _det_logger->info("DC tdc ref time cut = {} ", fTDC_RefTimeCut); + // cout << " DC tdc ref time cut = " << fTDC_RefTimeCut << endl; + InitHitList(fDetMap, "THcRawDCHit", fDetMap->GetTotNumChan() + 1, fTDC_RefTimeCut, 0); - CreateMissReportParms(Form("%sdc",fPrefix)); + CreateMissReportParms(Form("%sdc", fPrefix)); EStatus status; // This triggers call of ReadDatabase and DefineVariables - if( (status = THaTrackingDetector::Init( date )) ) - return fStatus=status; + if ((status = THaTrackingDetector::Init(date))) + return fStatus = status; // Initialize planes and add them to chambers - for(Int_t ip=0;ip<fNPlanes;ip++) { - if((status = fPlanes[ip]->Init( date ))) { - return fStatus=status; + for (Int_t ip = 0; ip < fNPlanes; ip++) { + if ((status = fPlanes[ip]->Init(date))) { + return fStatus = status; } else { - Int_t chamber=fNChamber[ip]; - fChambers[chamber-1]->AddPlane(fPlanes[ip]); + Int_t chamber = fNChamber[ip]; + fChambers[chamber - 1]->AddPlane(fPlanes[ip]); } } // Initialize chambers - for(UInt_t ic=0;ic<fNChambers;ic++) { - if((status = fChambers[ic]->Init ( date ))) { - return fStatus=status; + for (UInt_t ic = 0; ic < fNChambers; ic++) { + if ((status = fChambers[ic]->Init(date))) { + return fStatus = status; } } // Retrieve the fiting coefficients - fPlaneCoeffs = new Double_t* [fNPlanes]; - for(Int_t ip=0; ip<fNPlanes;ip++) { + fPlaneCoeffs = new Double_t*[fNPlanes]; + for (Int_t ip = 0; ip < fNPlanes; ip++) { fPlaneCoeffs[ip] = fPlanes[ip]->GetPlaneCoef(); } - fResiduals = new Double_t [fNPlanes]; - fResidualsExclPlane = new Double_t [fNPlanes]; - fWire_hit_did = new Double_t [fNPlanes]; - fWire_hit_should = new Double_t [fNPlanes]; - + fResiduals = new Double_t[fNPlanes]; + fResidualsExclPlane = new Double_t[fNPlanes]; + fWire_hit_did = new Double_t[fNPlanes]; + fWire_hit_should = new Double_t[fNPlanes]; // Replace with what we need for Hall C // const DataDest tmp[NDEST] = { @@ -254,18 +261,29 @@ THaAnalysisObject::EStatus THcDC::Init( const TDatime& date ) // { &fLTNhit, &fLANhit, fLT, fLT_c, fLA, fLA_p, fLA_c, fLOff, fLPed, fLGain } // }; // memcpy( fDataDest, tmp, NDEST*sizeof(DataDest) ); - - fPresentP = 0; - THaVar* vpresent = gHaVars->Find(Form("%s.present",GetApparatus()->GetName())); - if(vpresent) { - fPresentP = (Bool_t *) vpresent->GetValuePointer(); + + fPresentP = 0; + THaVar* vpresent = gHaVars->Find(Form("%s.present", GetApparatus()->GetName())); + if (vpresent) { + fPresentP = (Bool_t*)vpresent->GetValuePointer(); } return fStatus = kOK; } +//_____________________________________________________________________________ + +Int_t THcDC::ManualInitTree(TTree* t) { + std::string app_name = GetApparatus()->GetName(); + std::string det_name = GetName(); + std::string branch_name = (app_name + "_" + det_name + "_data"); + if (t) { + _det_logger->info("THcDC::ManualInitTree : Adding branch, {}, to output tree", branch_name); + t->Branch(branch_name.c_str(), &_basic_data, 32000, 99); + } + return 0; +} //_____________________________________________________________________________ -Int_t THcDC::ReadDatabase( const TDatime& date ) -{ +Int_t THcDC::ReadDatabase(const TDatime& date) { /** Read this detector's parameters from the ThcParmList This function is called by THaDetectorBase::Init() once at the @@ -274,110 +292,136 @@ Int_t THcDC::ReadDatabase( const TDatime& date ) */ // static const char* const here = "ReadDatabase()"; - delete [] fXCenter; fXCenter = new Double_t [fNChambers]; - delete [] fYCenter; fYCenter = new Double_t [fNChambers]; - delete [] fMinHits; fMinHits = new Int_t [fNChambers]; - delete [] fMaxHits; fMaxHits = new Int_t [fNChambers]; - delete [] fMinCombos; fMinCombos = new Int_t [fNChambers]; - delete [] fSpace_Point_Criterion; fSpace_Point_Criterion = new Double_t [fNChambers]; - - delete [] fTdcWinMin; fTdcWinMin = new Int_t [fNPlanes]; - delete [] fTdcWinMax; fTdcWinMax = new Int_t [fNPlanes]; - delete [] fCentralTime; fCentralTime = new Double_t [fNPlanes]; - delete [] fNWires; fNWires = new Int_t [fNPlanes]; - delete [] fNChamber; fNChamber = new Int_t [fNPlanes]; // Which chamber is this plane - delete [] fWireOrder; fWireOrder = new Int_t [fNPlanes]; // Wire readout order - delete [] fDriftTimeSign; fDriftTimeSign = new Int_t [fNPlanes]; - delete [] fReadoutLR; fReadoutLR = new Int_t [fNPlanes]; - delete [] fReadoutTB; fReadoutTB = new Int_t [fNPlanes]; - - delete [] fXPos; fXPos = new Double_t [fNPlanes]; - delete [] fYPos; fYPos = new Double_t [fNPlanes]; - delete [] fZPos; fZPos = new Double_t [fNPlanes]; - delete [] fAlphaAngle; fAlphaAngle = new Double_t [fNPlanes]; - delete [] fBetaAngle; fBetaAngle = new Double_t [fNPlanes]; - delete [] fGammaAngle; fGammaAngle = new Double_t [fNPlanes]; - delete [] fPitch; fPitch = new Double_t [fNPlanes]; - delete [] fCentralWire; fCentralWire = new Double_t [fNPlanes]; - delete [] fPlaneTimeZero; fPlaneTimeZero = new Double_t [fNPlanes]; - delete [] fSigma; fSigma = new Double_t [fNPlanes]; + delete[] fXCenter; + fXCenter = new Double_t[fNChambers]; + delete[] fYCenter; + fYCenter = new Double_t[fNChambers]; + delete[] fMinHits; + fMinHits = new Int_t[fNChambers]; + delete[] fMaxHits; + fMaxHits = new Int_t[fNChambers]; + delete[] fMinCombos; + fMinCombos = new Int_t[fNChambers]; + delete[] fSpace_Point_Criterion; + fSpace_Point_Criterion = new Double_t[fNChambers]; + + delete[] fTdcWinMin; + fTdcWinMin = new Int_t[fNPlanes]; + delete[] fTdcWinMax; + fTdcWinMax = new Int_t[fNPlanes]; + delete[] fCentralTime; + fCentralTime = new Double_t[fNPlanes]; + delete[] fNWires; + fNWires = new Int_t[fNPlanes]; + delete[] fNChamber; + fNChamber = new Int_t[fNPlanes]; // Which chamber is this plane + delete[] fWireOrder; + fWireOrder = new Int_t[fNPlanes]; // Wire readout order + delete[] fDriftTimeSign; + fDriftTimeSign = new Int_t[fNPlanes]; + delete[] fReadoutLR; + fReadoutLR = new Int_t[fNPlanes]; + delete[] fReadoutTB; + fReadoutTB = new Int_t[fNPlanes]; + + delete[] fXPos; + fXPos = new Double_t[fNPlanes]; + delete[] fYPos; + fYPos = new Double_t[fNPlanes]; + delete[] fZPos; + fZPos = new Double_t[fNPlanes]; + delete[] fAlphaAngle; + fAlphaAngle = new Double_t[fNPlanes]; + delete[] fBetaAngle; + fBetaAngle = new Double_t[fNPlanes]; + delete[] fGammaAngle; + fGammaAngle = new Double_t[fNPlanes]; + delete[] fPitch; + fPitch = new Double_t[fNPlanes]; + delete[] fCentralWire; + fCentralWire = new Double_t[fNPlanes]; + delete[] fPlaneTimeZero; + fPlaneTimeZero = new Double_t[fNPlanes]; + delete[] fSigma; + fSigma = new Double_t[fNPlanes]; Bool_t optional = true; - DBRequest list[]={ - {"dc_tdc_time_per_channel",&fNSperChan, kDouble}, - {"dc_wire_velocity",&fWireVelocity,kDouble}, - - {"dc_xcenter", fXCenter, kDouble, fNChambers}, - {"dc_ycenter", fYCenter, kDouble, fNChambers}, - {"min_hit", fMinHits, kInt, fNChambers}, - {"max_pr_hits", fMaxHits, kInt, fNChambers}, - {"min_combos", fMinCombos, kInt, fNChambers}, - {"space_point_criterion", fSpace_Point_Criterion, kDouble, fNChambers}, - - {"dc_tdc_min_win", fTdcWinMin, kInt, (UInt_t)fNPlanes}, - {"dc_tdc_max_win", fTdcWinMax, kInt, (UInt_t)fNPlanes}, - {"dc_central_time", fCentralTime, kDouble, (UInt_t)fNPlanes}, - {"dc_nrwire", fNWires, kInt, (UInt_t)fNPlanes}, - {"dc_chamber_planes", fNChamber, kInt, (UInt_t)fNPlanes}, - {"dc_wire_counting", fWireOrder, kInt, (UInt_t)fNPlanes}, - {"dc_drifttime_sign", fDriftTimeSign, kInt, (UInt_t)fNPlanes}, - {"dc_readoutLR", fReadoutLR, kInt, (UInt_t)fNPlanes, optional}, - {"dc_readoutTB", fReadoutTB, kInt, (UInt_t)fNPlanes, optional}, - - {"dc_zpos", fZPos, kDouble, (UInt_t)fNPlanes}, - {"dc_alpha_angle", fAlphaAngle, kDouble, (UInt_t)fNPlanes}, - {"dc_beta_angle", fBetaAngle, kDouble, (UInt_t)fNPlanes}, - {"dc_gamma_angle", fGammaAngle, kDouble, (UInt_t)fNPlanes}, - {"dc_pitch", fPitch, kDouble, (UInt_t)fNPlanes}, - {"dc_central_wire", fCentralWire, kDouble, (UInt_t)fNPlanes}, - {"dc_plane_time_zero", fPlaneTimeZero, kDouble, (UInt_t)fNPlanes}, - {"dc_sigma", fSigma, kDouble, (UInt_t)fNPlanes}, - {"single_stub",&fSingleStub, kInt,0,1}, - {"ntracks_max_fp", &fNTracksMaxFP, kInt}, - {"xt_track_criterion", &fXtTrCriterion, kDouble}, - {"yt_track_criterion", &fYtTrCriterion, kDouble}, - {"xpt_track_criterion", &fXptTrCriterion, kDouble}, - {"ypt_track_criterion", &fYptTrCriterion, kDouble}, - {"dc_fix_lr", &fFixLR, kInt}, - {"dc_fix_propcorr", &fFixPropagationCorrection, kInt}, - {"debuglinkstubs", &fdebuglinkstubs, kInt}, - {"debugprintrawdc", &fdebugprintrawdc, kInt}, - {"debugprintdecodeddc", &fdebugprintdecodeddc, kInt}, - {"debugflagpr", &fdebugflagpr, kInt}, - {"debugflagstubs", &fdebugflagstubs, kInt}, - {"debugtrackprint", &fdebugtrackprint , kInt}, - {0} - }; - fSingleStub=0; - for(Int_t ip=0; ip<fNPlanes;ip++) { + DBRequest list[] = {{"dc_tdc_time_per_channel", &fNSperChan, kDouble}, + {"dc_wire_velocity", &fWireVelocity, kDouble}, + + {"dc_xcenter", fXCenter, kDouble, fNChambers}, + {"dc_ycenter", fYCenter, kDouble, fNChambers}, + {"min_hit", fMinHits, kInt, fNChambers}, + {"max_pr_hits", fMaxHits, kInt, fNChambers}, + {"min_combos", fMinCombos, kInt, fNChambers}, + {"space_point_criterion", fSpace_Point_Criterion, kDouble, fNChambers}, + + {"dc_tdc_min_win", fTdcWinMin, kInt, (UInt_t)fNPlanes}, + {"dc_tdc_max_win", fTdcWinMax, kInt, (UInt_t)fNPlanes}, + {"dc_central_time", fCentralTime, kDouble, (UInt_t)fNPlanes}, + {"dc_nrwire", fNWires, kInt, (UInt_t)fNPlanes}, + {"dc_chamber_planes", fNChamber, kInt, (UInt_t)fNPlanes}, + {"dc_wire_counting", fWireOrder, kInt, (UInt_t)fNPlanes}, + {"dc_drifttime_sign", fDriftTimeSign, kInt, (UInt_t)fNPlanes}, + {"dc_readoutLR", fReadoutLR, kInt, (UInt_t)fNPlanes, optional}, + {"dc_readoutTB", fReadoutTB, kInt, (UInt_t)fNPlanes, optional}, + + {"dc_zpos", fZPos, kDouble, (UInt_t)fNPlanes}, + {"dc_alpha_angle", fAlphaAngle, kDouble, (UInt_t)fNPlanes}, + {"dc_beta_angle", fBetaAngle, kDouble, (UInt_t)fNPlanes}, + {"dc_gamma_angle", fGammaAngle, kDouble, (UInt_t)fNPlanes}, + {"dc_pitch", fPitch, kDouble, (UInt_t)fNPlanes}, + {"dc_central_wire", fCentralWire, kDouble, (UInt_t)fNPlanes}, + {"dc_plane_time_zero", fPlaneTimeZero, kDouble, (UInt_t)fNPlanes}, + {"dc_sigma", fSigma, kDouble, (UInt_t)fNPlanes}, + {"single_stub", &fSingleStub, kInt, 0, 1}, + {"ntracks_max_fp", &fNTracksMaxFP, kInt}, + {"xt_track_criterion", &fXtTrCriterion, kDouble}, + {"yt_track_criterion", &fYtTrCriterion, kDouble}, + {"xpt_track_criterion", &fXptTrCriterion, kDouble}, + {"ypt_track_criterion", &fYptTrCriterion, kDouble}, + {"dc_fix_lr", &fFixLR, kInt}, + {"dc_fix_propcorr", &fFixPropagationCorrection, kInt}, + {"debuglinkstubs", &fdebuglinkstubs, kInt}, + {"debugprintrawdc", &fdebugprintrawdc, kInt}, + {"debugprintdecodeddc", &fdebugprintdecodeddc, kInt}, + {"debugflagpr", &fdebugflagpr, kInt}, + {"debugflagstubs", &fdebugflagstubs, kInt}, + {"debugtrackprint", &fdebugtrackprint, kInt}, + {0}}; + fSingleStub = 0; + for (Int_t ip = 0; ip < fNPlanes; ip++) { fReadoutLR[ip] = 0.0; fReadoutTB[ip] = 0.0; - } - + } - gHcParms->LoadParmValues((DBRequest*)&list,fPrefix); + gHcParms->LoadParmValues((DBRequest*)&list, fPrefix); - //Set the default plane x,y positions to those of the chamber - for(Int_t ip=0; ip<fNPlanes;ip++) { - fXPos[ip] = fXCenter[GetNChamber(ip+1)-1]; - fYPos[ip] = fYCenter[GetNChamber(ip+1)-1]; - } + // Set the default plane x,y positions to those of the chamber + for (Int_t ip = 0; ip < fNPlanes; ip++) { + fXPos[ip] = fXCenter[GetNChamber(ip + 1) - 1]; + fYPos[ip] = fYCenter[GetNChamber(ip + 1) - 1]; + } - //Load the x,y positions of the planes if they exist (overwrites defaults) - DBRequest listOpt[]={ - {"dc_xpos", fXPos, kDouble, (UInt_t)fNPlanes, optional}, - {"dc_ypos", fYPos, kDouble, (UInt_t)fNPlanes, optional}, - {0} - }; - gHcParms->LoadParmValues((DBRequest*)&listOpt,fPrefix); - if(fNTracksMaxFP <= 0) fNTracksMaxFP = 10; + // Load the x,y positions of the planes if they exist (overwrites defaults) + DBRequest listOpt[] = {{"dc_xpos", fXPos, kDouble, (UInt_t)fNPlanes, optional}, + {"dc_ypos", fYPos, kDouble, (UInt_t)fNPlanes, optional}, + {0}}; + gHcParms->LoadParmValues((DBRequest*)&listOpt, fPrefix); + if (fNTracksMaxFP <= 0) + fNTracksMaxFP = 10; // if(fNTracksMaxFP > HNRACKS_MAX) fNTracksMaxFP = NHTRACKS_MAX; - cout << "Plane counts:"; - for(Int_t i=0;i<fNPlanes;i++) { - cout << " " << fNWires[i]; + + std::string plane_counts_string; + // cout << "Plane counts:"; + for (Int_t i = 0; i < fNPlanes; i++) { + // cout << " " << fNWires[i]; + plane_counts_string += std::string(" "); + plane_counts_string += std::to_string(fNWires[i]); } - cout << endl; + // cout << endl; + _det_logger->info("Plane counts: {}", plane_counts_string); fIsInit = true; @@ -385,148 +429,173 @@ Int_t THcDC::ReadDatabase( const TDatime& date ) } //_____________________________________________________________________________ -Int_t THcDC::DefineVariables( EMode mode ) -{ +Int_t THcDC::DefineVariables(EMode mode) { /** Initialize global variables for histograms and Root tree */ - if( mode == kDefine && fIsSetup ) return kOK; - fIsSetup = ( mode == kDefine ); + if (mode == kDefine && fIsSetup) + return kOK; + fIsSetup = (mode == kDefine); // Register variables in global list RVarDef vars[] = { - { "stubtest", "stub test", "fStubTest" }, - { "nhit", "Number of DC hits", "fNhits" }, - { "tnhit", "Number of good DC hits", "fNthits" }, - { "trawhit", "Number of true raw DC hits", "fN_True_RawHits" }, - { "ntrack", "Number of Tracks", "fNDCTracks" }, - { "nsp", "Number of Space Points", "fNSp" }, - { "track_nsp", "Number of spacepoints in track", "fDCTracks.THcDCTrack.GetNSpacePoints()"}, - { "x", "X at focal plane", "fDCTracks.THcDCTrack.GetX()"}, - { "y", "Y at focal plane", "fDCTracks.THcDCTrack.GetY()"}, - { "xp", "XP at focal plane", "fDCTracks.THcDCTrack.GetXP()"}, - { "yp", "YP at focal plane", "fDCTracks.THcDCTrack.GetYP()"}, - { "x_fp", "X at focal plane (golden track)", "fX_fp_best"}, - { "y_fp", "Y at focal plane( golden track)", "fY_fp_best"}, - { "xp_fp", "XP at focal plane (golden track)", "fXp_fp_best"}, - { "yp_fp", "YP at focal plane(golden track) ", "fYp_fp_best"}, - { "chisq", "chisq/dof (golden track) ", "fChisq_best"}, - { "sp1_id", " (golden track) ", "fSp1_ID_best"}, - { "sp2_id", " (golden track) ", "fSp2_ID_best"}, - { "InsideDipoleExit", " ","fInSideDipoleExit_best"}, - { "gtrack_nsp", " Number of space points in golden track ", "fNsp_best"}, - { "residual", "Residuals", "fResiduals"}, - { "residualExclPlane", "Residuals", "fResidualsExclPlane"}, - { "wireHitDid","Wire did have matched track hit", "fWire_hit_did"}, - { "wireHitShould", "Wire should have matched track hit", "fWire_hit_should"}, - { 0 } - }; - return DefineVarsFromList( vars, mode ); - + {"stubtest", "stub test", "fStubTest"}, + {"nhit", "Number of DC hits", "fNhits"}, + {"tnhit", "Number of good DC hits", "fNthits"}, + {"trawhit", "Number of true raw DC hits", "fN_True_RawHits"}, + {"ntrack", "Number of Tracks", "fNDCTracks"}, + {"nsp", "Number of Space Points", "fNSp"}, + {"track_nsp", "Number of spacepoints in track", "fDCTracks.THcDCTrack.GetNSpacePoints()"}, + {"x", "X at focal plane", "fDCTracks.THcDCTrack.GetX()"}, + {"y", "Y at focal plane", "fDCTracks.THcDCTrack.GetY()"}, + {"xp", "XP at focal plane", "fDCTracks.THcDCTrack.GetXP()"}, + {"yp", "YP at focal plane", "fDCTracks.THcDCTrack.GetYP()"}, + {"x_fp", "X at focal plane (golden track)", "fX_fp_best"}, + {"y_fp", "Y at focal plane( golden track)", "fY_fp_best"}, + {"xp_fp", "XP at focal plane (golden track)", "fXp_fp_best"}, + {"yp_fp", "YP at focal plane(golden track) ", "fYp_fp_best"}, + {"chisq", "chisq/dof (golden track) ", "fChisq_best"}, + {"sp1_id", " (golden track) ", "fSp1_ID_best"}, + {"sp2_id", " (golden track) ", "fSp2_ID_best"}, + {"InsideDipoleExit", " ", "fInSideDipoleExit_best"}, + {"gtrack_nsp", " Number of space points in golden track ", "fNsp_best"}, + {"residual", "Residuals", "fResiduals"}, + {"residualExclPlane", "Residuals", "fResidualsExclPlane"}, + {"wireHitDid", "Wire did have matched track hit", "fWire_hit_did"}, + {"wireHitShould", "Wire should have matched track hit", "fWire_hit_should"}, + {0}}; + return DefineVarsFromList(vars, mode); } //_____________________________________________________________________________ -THcDC::~THcDC() -{ +THcDC::~THcDC() { // Destructor. Remove variables from global list. - if( fIsSetup ) + if (fIsSetup) RemoveVariables(); - if( fIsInit ) + if (fIsInit) DeleteArrays(); // Delete the plane objects - for (vector<THcDriftChamberPlane*>::iterator ip = fPlanes.begin(); - ip != fPlanes.end(); ++ip) delete *ip; + for (vector<THcDriftChamberPlane*>::iterator ip = fPlanes.begin(); ip != fPlanes.end(); ++ip) + delete *ip; // Delete the chamber objects - for (vector<THcDriftChamber*>::iterator ip = fChambers.begin(); - ip != fChambers.end(); ++ip) delete *ip; + for (vector<THcDriftChamber*>::iterator ip = fChambers.begin(); ip != fChambers.end(); ++ip) + delete *ip; delete fDCTracks; } //_____________________________________________________________________________ -void THcDC::DeleteArrays() -{ +void THcDC::DeleteArrays() { // Delete member arrays. Used by destructor. - delete [] fXCenter; fXCenter = NULL; - delete [] fYCenter; fYCenter = NULL; - delete [] fMinHits; fMinHits = NULL; - delete [] fMaxHits; fMaxHits = NULL; - delete [] fMinCombos; fMinCombos = NULL; - delete [] fSpace_Point_Criterion; fSpace_Point_Criterion = NULL; - - delete [] fTdcWinMin; fTdcWinMin = NULL; - delete [] fTdcWinMax; fTdcWinMax = NULL; - delete [] fCentralTime; fCentralTime = NULL; - delete [] fNWires; fNWires = NULL; - delete [] fNChamber; fNChamber = NULL; - delete [] fWireOrder; fWireOrder = NULL; - delete [] fDriftTimeSign; fDriftTimeSign = NULL; - delete [] fReadoutLR; fReadoutLR = NULL; - delete [] fReadoutTB; fReadoutTB = NULL; - - delete [] fXPos; fXPos = NULL; - delete [] fYPos; fYPos = NULL; - delete [] fZPos; fZPos = NULL; - delete [] fAlphaAngle; fAlphaAngle = NULL; - delete [] fBetaAngle; fBetaAngle = NULL; - delete [] fGammaAngle; fGammaAngle = NULL; - delete [] fPitch; fPitch = NULL; - delete [] fCentralWire; fCentralWire = NULL; - delete [] fPlaneTimeZero; fPlaneTimeZero = NULL; - delete [] fSigma; fSigma = NULL; + delete[] fXCenter; + fXCenter = NULL; + delete[] fYCenter; + fYCenter = NULL; + delete[] fMinHits; + fMinHits = NULL; + delete[] fMaxHits; + fMaxHits = NULL; + delete[] fMinCombos; + fMinCombos = NULL; + delete[] fSpace_Point_Criterion; + fSpace_Point_Criterion = NULL; + + delete[] fTdcWinMin; + fTdcWinMin = NULL; + delete[] fTdcWinMax; + fTdcWinMax = NULL; + delete[] fCentralTime; + fCentralTime = NULL; + delete[] fNWires; + fNWires = NULL; + delete[] fNChamber; + fNChamber = NULL; + delete[] fWireOrder; + fWireOrder = NULL; + delete[] fDriftTimeSign; + fDriftTimeSign = NULL; + delete[] fReadoutLR; + fReadoutLR = NULL; + delete[] fReadoutTB; + fReadoutTB = NULL; + + delete[] fXPos; + fXPos = NULL; + delete[] fYPos; + fYPos = NULL; + delete[] fZPos; + fZPos = NULL; + delete[] fAlphaAngle; + fAlphaAngle = NULL; + delete[] fBetaAngle; + fBetaAngle = NULL; + delete[] fGammaAngle; + fGammaAngle = NULL; + delete[] fPitch; + fPitch = NULL; + delete[] fCentralWire; + fCentralWire = NULL; + delete[] fPlaneTimeZero; + fPlaneTimeZero = NULL; + delete[] fSigma; + fSigma = NULL; // Efficiency arrays - delete [] fNChamHits; fNChamHits = NULL; - delete [] fPlaneEvents; fPlaneEvents = NULL; - - for( Int_t i = 0; i<fNPlanes; ++i ) - delete [] fPlaneNames[i]; - delete [] fPlaneNames; - - delete [] fPlaneCoeffs; fPlaneCoeffs = 0; - delete [] fResiduals; fResiduals = 0; - delete [] fResidualsExclPlane; fResidualsExclPlane = 0; - delete [] fWire_hit_did; fWire_hit_did = 0; - delete [] fWire_hit_should; fWire_hit_should = 0; + delete[] fNChamHits; + fNChamHits = NULL; + delete[] fPlaneEvents; + fPlaneEvents = NULL; + + for (Int_t i = 0; i < fNPlanes; ++i) + delete[] fPlaneNames[i]; + delete[] fPlaneNames; + + delete[] fPlaneCoeffs; + fPlaneCoeffs = 0; + delete[] fResiduals; + fResiduals = 0; + delete[] fResidualsExclPlane; + fResidualsExclPlane = 0; + delete[] fWire_hit_did; + fWire_hit_did = 0; + delete[] fWire_hit_should; + fWire_hit_should = 0; } //_____________________________________________________________________________ -inline -void THcDC::ClearEvent() -{ +inline void THcDC::ClearEvent() { // Reset per-event data. - fStubTest = 0; - fNhits = 0; - fNthits = 0; - fN_True_RawHits=0; - fX_fp_best=-10000.; - fY_fp_best=-10000.; - fXp_fp_best=-10000.; - fYp_fp_best=-10000.; - fChisq_best=kBig; - fNsp_best=0; + fStubTest = 0; + fNhits = 0; + fNthits = 0; + fN_True_RawHits = 0; + fX_fp_best = -10000.; + fY_fp_best = -10000.; + fXp_fp_best = -10000.; + fYp_fp_best = -10000.; + fChisq_best = kBig; + fNsp_best = 0; fInSideDipoleExit_best = kTRUE; - for(UInt_t i=0;i<fNChambers;i++) { + for (UInt_t i = 0; i < fNChambers; i++) { fChambers[i]->Clear(); } - for(Int_t i=0;i<fNPlanes;i++) { - fResiduals[i] = 1000.0; + for (Int_t i = 0; i < fNPlanes; i++) { + fResiduals[i] = 1000.0; fResidualsExclPlane[i] = 1000.0; - fWire_hit_did[i] = 1000.0; - fWire_hit_should[i] = 1000.0; + fWire_hit_did[i] = 1000.0; + fWire_hit_should[i] = 1000.0; } // fTrackProj->Clear(); } //_____________________________________________________________________________ -Int_t THcDC::Decode( const THaEvData& evdata ) -{ +Int_t THcDC::Decode(const THaEvData& evdata) { /** Decode event into hit list. Pass hit list to the planes. @@ -534,54 +603,52 @@ Int_t THcDC::Decode( const THaEvData& evdata ) */ ClearEvent(); Int_t num_event = evdata.GetEvNum(); - if (fdebugprintrawdc ||fdebugprintdecodeddc || fdebuglinkstubs || fdebugtrackprint) cout << " event num = " << num_event << endl; + if (fdebugprintrawdc || fdebugprintdecodeddc || fdebuglinkstubs || fdebugtrackprint) + cout << " event num = " << num_event << endl; // Get the Hall C style hitlist (fRawHitList) for this event - Bool_t present = kTRUE; // Suppress reference time warnings - if(fPresentP) { // if this spectrometer not part of trigger + Bool_t present = kTRUE; // Suppress reference time warnings + if (fPresentP) { // if this spectrometer not part of trigger present = *fPresentP; } fNhits = DecodeToHitList(evdata, !present); - - - if(!gHaCuts->Result("Pedestal_event")) { + if (!gHaCuts->Result("Pedestal_event")) { // Let each plane get its hits Int_t nexthit = 0; - for(Int_t ip=0;ip<fNPlanes;ip++) { + for (Int_t ip = 0; ip < fNPlanes; ip++) { nexthit = fPlanes[ip]->ProcessHits(fRawHitList, nexthit); fN_True_RawHits += fPlanes[ip]->GetNRawhits(); - } // fRawHitList is TClones array of THcRawDCHit objects - Int_t counter=0; + Int_t counter = 0; if (fdebugprintrawdc) { - cout << " RAW_TOT_HITS = " << fNRawHits << endl; - cout << " Hit # " << "Plane " << " Wire " << " Raw TDC " << endl; - for(UInt_t ihit = 0; ihit < fNRawHits ; ihit++) { - THcRawDCHit* hit = (THcRawDCHit *) fRawHitList->At(ihit); - for(UInt_t imhit = 0; imhit < hit->GetRawTdcHit().GetNHits(); imhit++) { - counter++; - cout << counter << " " << hit->fPlane << " " << hit->fCounter << " " << hit->GetRawTdcHit().GetTimeRaw(imhit) << endl; - } + cout << " RAW_TOT_HITS = " << fNRawHits << endl; + cout << " Hit # " + << "Plane " + << " Wire " + << " Raw TDC " << endl; + for (UInt_t ihit = 0; ihit < fNRawHits; ihit++) { + THcRawDCHit* hit = (THcRawDCHit*)fRawHitList->At(ihit); + for (UInt_t imhit = 0; imhit < hit->GetRawTdcHit().GetNHits(); imhit++) { + counter++; + cout << counter << " " << hit->fPlane << " " << hit->fCounter << " " + << hit->GetRawTdcHit().GetTimeRaw(imhit) << endl; + } } cout << endl; } - Eff(); // Accumlate statistics + Eff(); // Accumlate statistics } return fNhits; } //_____________________________________________________________________________ -Int_t THcDC::ApplyCorrections( void ) -{ - return(0); -} +Int_t THcDC::ApplyCorrections(void) { return (0); } //_____________________________________________________________________________ -Int_t THcDC::CoarseTrack( TClonesArray& tracks ) -{ +Int_t THcDC::CoarseTrack(TClonesArray& tracks) { /** Find a set of tracks through the drift chambers and put them into the tracks TClonesArray. @@ -589,48 +656,50 @@ Int_t THcDC::CoarseTrack( TClonesArray& tracks ) */ // Subtract starttimes from each plane hit - for(Int_t ip=0;ip<fNPlanes;ip++) { - fPlanes[ip]->SubtractStartTime(); - } + for (Int_t ip = 0; ip < fNPlanes; ip++) { + fPlanes[ip]->SubtractStartTime(); + } // - // Let each chamber get its hits - for(UInt_t ic=0;ic<fNChambers;ic++) { - fChambers[ic]->ProcessHits(); - fNthits += fChambers[ic]->GetNHits(); - if (fdebugprintdecodeddc)fChambers[ic]->PrintDecode(); - } - // - for(UInt_t i=0;i<fNChambers;i++) { + // Let each chamber get its hits + for (UInt_t ic = 0; ic < fNChambers; ic++) { + fChambers[ic]->ProcessHits(); + fNthits += fChambers[ic]->GetNHits(); + if (fdebugprintdecodeddc) + fChambers[ic]->PrintDecode(); + } + // + for (UInt_t i = 0; i < fNChambers; i++) { fChambers[i]->FindSpacePoints(); fChambers[i]->CorrectHitTimes(); fChambers[i]->LeftRight(); } - if (fdebugflagstubs) PrintSpacePoints(); - if (fdebugflagstubs) PrintStubs(); + if (fdebugflagstubs) + PrintSpacePoints(); + if (fdebugflagstubs) + PrintStubs(); // Now link the stubs between chambers LinkStubs(); - if(fNDCTracks > 0) { - TrackFit(); + if (fNDCTracks > 0) { + TrackFit(); // Copy tracks into podd tracks list - for(UInt_t itrack=0;itrack<fNDCTracks;itrack++) { + for (UInt_t itrack = 0; itrack < fNDCTracks; itrack++) { THaTrack* theTrack = NULL; - theTrack = AddTrack(tracks, 0.0, 0.0, 0.0, 0.0); // Leaving off trackID + theTrack = AddTrack(tracks, 0.0, 0.0, 0.0, 0.0); // Leaving off trackID // Should we add stubs with AddCluster? Could we do this // by having stubs inherit from cluster - THcDCTrack *tr = static_cast<THcDCTrack*>( fDCTracks->At(itrack)); + THcDCTrack* tr = static_cast<THcDCTrack*>(fDCTracks->At(itrack)); theTrack->Set(tr->GetX(), tr->GetY(), tr->GetXP(), tr->GetYP()); - theTrack->SetFlag((UInt_t) 0); + theTrack->SetFlag((UInt_t)0); // Need to look at how engine does chi2 and track selection. Reduced? - theTrack->SetChi2(tr->GetChisq(),tr->GetNFree()); + theTrack->SetChi2(tr->GetChisq(), tr->GetNFree()); // CalcFocalPlaneCoords. Aren't our tracks already in focal plane coords // We should have some kind of track ID so that the THaTrack can be // associate back with the DC track // Assign the track number - theTrack->SetTrkNum(itrack+1); + theTrack->SetTrkNum(itrack + 1); } - } - + } ApplyCorrections(); @@ -638,66 +707,66 @@ Int_t THcDC::CoarseTrack( TClonesArray& tracks ) } //_____________________________________________________________________________ -Int_t THcDC::FineTrack( TClonesArray& tracks ) -{ - - return 0; -} +Int_t THcDC::FineTrack(TClonesArray& tracks) { return 0; } // -void THcDC::SetFocalPlaneBestTrack(Int_t golden_track_index) -{ - THcDCTrack *tr1 = static_cast<THcDCTrack*>( fDCTracks->At(golden_track_index)); - fX_fp_best=tr1->GetX(); - fY_fp_best=tr1->GetY(); - fXp_fp_best=tr1->GetXP(); - fYp_fp_best=tr1->GetYP(); - THcHallCSpectrometer *app = dynamic_cast<THcHallCSpectrometer*>(GetApparatus()); - fInSideDipoleExit_best = app->InsideDipoleExitWindow(fX_fp_best, fXp_fp_best ,fY_fp_best,fYp_fp_best); - fSp1_ID_best=tr1->GetSp1_ID(); - fSp2_ID_best=tr1->GetSp2_ID(); - fChisq_best=tr1->GetChisq(); - fNsp_best=tr1->GetNSpacePoints(); - for (UInt_t ihit = 0; ihit < UInt_t (tr1->GetNHits()); ihit++) { - THcDCHit *hit = tr1->GetHit(ihit); - Int_t plane = hit->GetPlaneNum() - 1; - fResiduals[plane] = tr1->GetResidual(plane); - fResidualsExclPlane[plane] = tr1->GetResidualExclPlane(plane); - } - EfficiencyPerWire(golden_track_index); +void THcDC::SetFocalPlaneBestTrack(Int_t golden_track_index) { + THcDCTrack* tr1 = static_cast<THcDCTrack*>(fDCTracks->At(golden_track_index)); + fX_fp_best = tr1->GetX(); + fY_fp_best = tr1->GetY(); + fXp_fp_best = tr1->GetXP(); + fYp_fp_best = tr1->GetYP(); + THcHallCSpectrometer* app = dynamic_cast<THcHallCSpectrometer*>(GetApparatus()); + fInSideDipoleExit_best = + app->InsideDipoleExitWindow(fX_fp_best, fXp_fp_best, fY_fp_best, fYp_fp_best); + fSp1_ID_best = tr1->GetSp1_ID(); + fSp2_ID_best = tr1->GetSp2_ID(); + fChisq_best = tr1->GetChisq(); + fNsp_best = tr1->GetNSpacePoints(); + for (UInt_t ihit = 0; ihit < UInt_t(tr1->GetNHits()); ihit++) { + THcDCHit* hit = tr1->GetHit(ihit); + Int_t plane = hit->GetPlaneNum() - 1; + _basic_data._Residuals[plane] = tr1->GetResidual(plane); + fResiduals[plane] = tr1->GetResidual(plane); + _basic_data._ResidualsExclPlane[plane] = tr1->GetResidualExclPlane(plane); + fResidualsExclPlane[plane] = tr1->GetResidualExclPlane(plane); + } + EfficiencyPerWire(golden_track_index); } // -void THcDC::EfficiencyPerWire(Int_t golden_track_index) -{ - THcDCTrack *tr1 = static_cast<THcDCTrack*>( fDCTracks->At(golden_track_index)); - Double_t track_pos; - for (UInt_t ihit = 0; ihit < UInt_t (tr1->GetNHits()); ihit++) { - THcDCHit *hit = tr1->GetHit(ihit); - Int_t plane = hit->GetPlaneNum() - 1; - track_pos=tr1->GetCoord(plane); - Int_t wire_num = hit->GetWireNum(); - Int_t wire_track_num=round(fPlanes[plane]->CalcWireFromPos(track_pos)); - if ( (wire_num-wire_track_num) ==0) fWire_hit_did[plane]=wire_num; - } - for(Int_t ip=0; ip<fNPlanes;ip++) { - track_pos=tr1->GetCoord(ip); - Int_t wire_should = round(fPlanes[ip]->CalcWireFromPos(track_pos)); - fWire_hit_should[ip]=wire_should; +void THcDC::EfficiencyPerWire(Int_t golden_track_index) { + THcDCTrack* tr1 = static_cast<THcDCTrack*>(fDCTracks->At(golden_track_index)); + Double_t track_pos; + for (UInt_t ihit = 0; ihit < UInt_t(tr1->GetNHits()); ihit++) { + THcDCHit* hit = tr1->GetHit(ihit); + Int_t plane = hit->GetPlaneNum() - 1; + track_pos = tr1->GetCoord(plane); + Int_t wire_num = hit->GetWireNum(); + Int_t wire_track_num = round(fPlanes[plane]->CalcWireFromPos(track_pos)); + if ((wire_num - wire_track_num) == 0) + fWire_hit_did[plane] = wire_num; + } + for (Int_t ip = 0; ip < fNPlanes; ip++) { + track_pos = tr1->GetCoord(ip); + Int_t wire_should = round(fPlanes[ip]->CalcWireFromPos(track_pos)); + fWire_hit_should[ip] = wire_should; } } // -void THcDC::PrintSpacePoints() -{ - for(UInt_t ich=0;ich<fNChambers;ich++) { - printf("%s %2d %s %3d %s %3d \n"," chamber = ",fChambers[ich]->GetChamberNum()," number of hits = ",fChambers[ich]->GetNHits()," number of spacepoints = ",fChambers[ich]->GetNSpacePoints()); - printf("%6s %-8s %-8s %6s %6s %10s \n"," "," "," ","Number","Number","Plane Wire"); - printf("%6s %-8s %-8s %6s %6s %10s \n","Point","x","y"," hits ","combos"," for each hit"); +void THcDC::PrintSpacePoints() { + for (UInt_t ich = 0; ich < fNChambers; ich++) { + printf("%s %2d %s %3d %s %3d \n", " chamber = ", fChambers[ich]->GetChamberNum(), + " number of hits = ", fChambers[ich]->GetNHits(), + " number of spacepoints = ", fChambers[ich]->GetNSpacePoints()); + printf("%6s %-8s %-8s %6s %6s %10s \n", " ", " ", " ", "Number", "Number", "Plane Wire"); + printf("%6s %-8s %-8s %6s %6s %10s \n", "Point", "x", "y", " hits ", "combos", " for each hit"); TClonesArray* spacepointarray = fChambers[ich]->GetSpacePointsP(); - for(Int_t isp=0;isp<fChambers[ich]->GetNSpacePoints();isp++) { + for (Int_t isp = 0; isp < fChambers[ich]->GetNSpacePoints(); isp++) { THcSpacePoint* sp = (THcSpacePoint*)(spacepointarray->At(isp)); - printf("%5d %8.5f %8.5f %5d %5d ",isp+1,sp->GetX(),sp->GetY(),sp->GetNHits(),sp->GetCombos()) ; - for (Int_t ii=0;ii<sp->GetNHits();ii++) { - THcDCHit* hittemp = (THcDCHit*)(sp->GetHit(ii)); - printf("%3d %3d %3d",hittemp->GetPlaneNum(),hittemp->GetWireNum(),hittemp->GetLR()); + printf("%5d %8.5f %8.5f %5d %5d ", isp + 1, sp->GetX(), sp->GetY(), sp->GetNHits(), + sp->GetCombos()); + for (Int_t ii = 0; ii < sp->GetNHits(); ii++) { + THcDCHit* hittemp = (THcDCHit*)(sp->GetHit(ii)); + printf("%3d %3d %3d", hittemp->GetPlaneNum(), hittemp->GetWireNum(), hittemp->GetLR()); } printf("\n"); } @@ -705,24 +774,23 @@ void THcDC::PrintSpacePoints() } // // -void THcDC::PrintStubs() -{ - for(UInt_t ich=0;ich<fNChambers;ich++) { - printf("%s %3d \n"," Stub fit results Chamber = ",ich+1); - printf("%-5s %-18s %-18s %-18s %-18s\n","point","x_t","y_t","xp_t","yp_t"); - printf("%-5s %-18s %-18s %-18s %-18s\n"," ","[cm]","[cm]","[cm]","[cm]"); +void THcDC::PrintStubs() { + for (UInt_t ich = 0; ich < fNChambers; ich++) { + printf("%s %3d \n", " Stub fit results Chamber = ", ich + 1); + printf("%-5s %-18s %-18s %-18s %-18s\n", "point", "x_t", "y_t", "xp_t", "yp_t"); + printf("%-5s %-18s %-18s %-18s %-18s\n", " ", "[cm]", "[cm]", "[cm]", "[cm]"); TClonesArray* spacepointarray = fChambers[ich]->GetSpacePointsP(); - for(Int_t isp=0;isp<fChambers[ich]->GetNSpacePoints();isp++) { - THcSpacePoint* sp = (THcSpacePoint*)(spacepointarray->At(isp)); - Double_t *spstubt=sp->GetStubP(); - printf("%-5d % 15.10e % 15.10e % 15.10e % 15.10e \n",isp+1,spstubt[0],spstubt[1],spstubt[2],spstubt[3]); + for (Int_t isp = 0; isp < fChambers[ich]->GetNSpacePoints(); isp++) { + THcSpacePoint* sp = (THcSpacePoint*)(spacepointarray->At(isp)); + Double_t* spstubt = sp->GetStubP(); + printf("%-5d % 15.10e % 15.10e % 15.10e % 15.10e \n", isp + 1, spstubt[0], spstubt[1], + spstubt[2], spstubt[3]); } } } // //_____________________________________________________________________________ -void THcDC::LinkStubs() -{ +void THcDC::LinkStubs() { /** The logic is 0) Put all space points in a single list @@ -739,194 +807,215 @@ void THcDC::LinkStubs() */ std::vector<THcSpacePoint*> fSp; - fNSp=0; + fNSp = 0; fSp.clear(); fSp.reserve(100); - fNDCTracks=0; // Number of Focal Plane tracks found + fNDCTracks = 0; // Number of Focal Plane tracks found fDCTracks->Delete(); // Make a vector of pointers to the SpacePoints - //if (fChambers[0]->GetNSpacePoints()+fChambers[1]->GetNSpacePoints()>10) return; + // if (fChambers[0]->GetNSpacePoints()+fChambers[1]->GetNSpacePoints()>10) return; - for(UInt_t ich=0;ich<fNChambers;ich++) { - Int_t nchamber=fChambers[ich]->GetChamberNum(); + for (UInt_t ich = 0; ich < fNChambers; ich++) { + Int_t nchamber = fChambers[ich]->GetChamberNum(); TClonesArray* spacepointarray = fChambers[ich]->GetSpacePointsP(); - for(Int_t isp=0;isp<fChambers[ich]->GetNSpacePoints();isp++) { + for (Int_t isp = 0; isp < fChambers[ich]->GetNSpacePoints(); isp++) { fSp.push_back(static_cast<THcSpacePoint*>(spacepointarray->At(isp))); - fSp[fNSp]->fNChamber = nchamber; + fSp[fNSp]->fNChamber = nchamber; fSp[fNSp]->fNChamber_spnum = isp; fNSp++; - if (ich==0 && fNSp>50) break; - if (fNSp>100) break; + if (ich == 0 && fNSp > 50) + break; + if (fNSp > 100) + break; } } - Double_t stubminx = 999999; - Double_t stubminy = 999999; + Double_t stubminx = 999999; + Double_t stubminy = 999999; Double_t stubminxp = 999999; Double_t stubminyp = 999999; - Int_t stub_tracks[MAXTRACKS]; - if(fSingleStub==0) { - for(Int_t isp1=0;isp1<fNSp-1;isp1++) { // isp1 is index/id in total list of space points - THcSpacePoint* sp1 = fSp[isp1]; - Int_t sptracks=0; + Int_t stub_tracks[MAXTRACKS]; + if (fSingleStub == 0) { + for (Int_t isp1 = 0; isp1 < fNSp - 1; + isp1++) { // isp1 is index/id in total list of space points + THcSpacePoint* sp1 = fSp[isp1]; + Int_t sptracks = 0; // Now make sure this sp is not already used in a sp. // Could this be done by having a sp point to the track it is in? - Int_t tryflag=1; - for(UInt_t itrack=0;itrack<fNDCTracks;itrack++) { - THcDCTrack *theDCTrack = static_cast<THcDCTrack*>( fDCTracks->At(itrack)); - for(Int_t isp=0;isp<theDCTrack->GetNSpacePoints();isp++) { - // isp is index into list of space points attached to theDCTrack - if(theDCTrack->GetSpacePoint(isp) == sp1) { - tryflag=0; - } - } + Int_t tryflag = 1; + for (UInt_t itrack = 0; itrack < fNDCTracks; itrack++) { + THcDCTrack* theDCTrack = static_cast<THcDCTrack*>(fDCTracks->At(itrack)); + for (Int_t isp = 0; isp < theDCTrack->GetNSpacePoints(); isp++) { + // isp is index into list of space points attached to theDCTrack + if (theDCTrack->GetSpacePoint(isp) == sp1) { + tryflag = 0; + } + } } - if(tryflag) { // SP not already part of a track - Int_t newtrack=1; - for(Int_t isp2=isp1+1;isp2<fNSp;isp2++) { - THcSpacePoint* sp2=fSp[isp2]; - if(sp1->fNChamber!=sp2->fNChamber&&sp1->GetSetStubFlag()&&sp2->GetSetStubFlag()) { - Double_t *spstub1=sp1->GetStubP(); - Double_t *spstub2=sp2->GetStubP(); - Double_t dposx = spstub1[0] - spstub2[0]; - Double_t dposy; - if(fProjectToChamber) { // From SOS s_link_stubs - // Since single chamber resolution is ~50mr, and the maximum y` - // angle is about 30mr, use differenece between y AT CHAMBERS, rather - // than at focal plane. (Project back to chamber, to take out y' uncertainty) - // (Should this be done for SHMS and HMS too?) - Double_t y1=spstub1[1]+fChambers[sp1->fNChamber]->GetZPos()*spstub1[3]; - Double_t y2=spstub2[1]+fChambers[sp2->fNChamber]->GetZPos()*spstub2[3]; - dposy = y1-y2; - } else { - dposy = spstub1[1] - spstub2[1]; - } - Double_t dposxp = spstub1[2] - spstub2[2]; - Double_t dposyp = spstub1[3] - spstub2[3]; - - // What is the point of saving these stubmin values. They - // Don't seem to be used anywhere except that they can be - // printed out if hbypass_track_eff_files is zero. - if(TMath::Abs(dposx)<TMath::Abs(stubminx)) stubminx = dposx; - if(TMath::Abs(dposy)<TMath::Abs(stubminy)) stubminy = dposy; - if(TMath::Abs(dposxp)<TMath::Abs(stubminxp)) stubminxp = dposxp; - if(TMath::Abs(dposyp)<TMath::Abs(stubminyp)) stubminyp = dposyp; - - // if hbypass_track_eff_files == 0 then - // Print out each stubminX that is less that its criterion - - if((TMath::Abs(dposx) < fXtTrCriterion) - && (TMath::Abs(dposy) < fYtTrCriterion) - && (TMath::Abs(dposxp) < fXptTrCriterion) - && (TMath::Abs(dposyp) < fYptTrCriterion)) { - if(newtrack) { - assert(sptracks==0); - fStubTest = 1; - //stubtest=1; Used in h_track_tests.f - // Make a new track if there are not to many - if(fNDCTracks < fNTracksMaxFP) { - sptracks=0; // Number of tracks with this seed - stub_tracks[sptracks++] = fNDCTracks; - THcDCTrack *theDCTrack = new( (*fDCTracks)[fNDCTracks++]) THcDCTrack(fNPlanes); - theDCTrack->AddSpacePoint(sp1); - theDCTrack->AddSpacePoint(sp2); - if (sp1->fNChamber==1) theDCTrack->SetSp1_ID(sp1->fNChamber_spnum); - if (sp1->fNChamber==2) theDCTrack->SetSp2_ID(sp1->fNChamber_spnum); - if (sp2->fNChamber==1) theDCTrack->SetSp1_ID(sp2->fNChamber_spnum); - if (sp2->fNChamber==2) theDCTrack->SetSp2_ID(sp2->fNChamber_spnum); - newtrack = 0; // Make no more tracks in this loop - // (But could replace a SP?) - } else { + if (tryflag) { // SP not already part of a track + Int_t newtrack = 1; + for (Int_t isp2 = isp1 + 1; isp2 < fNSp; isp2++) { + THcSpacePoint* sp2 = fSp[isp2]; + if (sp1->fNChamber != sp2->fNChamber && sp1->GetSetStubFlag() && sp2->GetSetStubFlag()) { + Double_t* spstub1 = sp1->GetStubP(); + Double_t* spstub2 = sp2->GetStubP(); + Double_t dposx = spstub1[0] - spstub2[0]; + Double_t dposy; + if (fProjectToChamber) { // From SOS s_link_stubs + // Since single chamber resolution is ~50mr, and the maximum y` + // angle is about 30mr, use differenece between y AT CHAMBERS, rather + // than at focal plane. (Project back to chamber, to take out y' uncertainty) + // (Should this be done for SHMS and HMS too?) + Double_t y1 = spstub1[1] + fChambers[sp1->fNChamber]->GetZPos() * spstub1[3]; + Double_t y2 = spstub2[1] + fChambers[sp2->fNChamber]->GetZPos() * spstub2[3]; + dposy = y1 - y2; + } else { + dposy = spstub1[1] - spstub2[1]; + } + Double_t dposxp = spstub1[2] - spstub2[2]; + Double_t dposyp = spstub1[3] - spstub2[3]; + + // What is the point of saving these stubmin values. They + // Don't seem to be used anywhere except that they can be + // printed out if hbypass_track_eff_files is zero. + if (TMath::Abs(dposx) < TMath::Abs(stubminx)) + stubminx = dposx; + if (TMath::Abs(dposy) < TMath::Abs(stubminy)) + stubminy = dposy; + if (TMath::Abs(dposxp) < TMath::Abs(stubminxp)) + stubminxp = dposxp; + if (TMath::Abs(dposyp) < TMath::Abs(stubminyp)) + stubminyp = dposyp; + + // if hbypass_track_eff_files == 0 then + // Print out each stubminX that is less that its criterion + + if ((TMath::Abs(dposx) < fXtTrCriterion) && (TMath::Abs(dposy) < fYtTrCriterion) && + (TMath::Abs(dposxp) < fXptTrCriterion) && (TMath::Abs(dposyp) < fYptTrCriterion)) { + if (newtrack) { + assert(sptracks == 0); + fStubTest = 1; + // stubtest=1; Used in h_track_tests.f + // Make a new track if there are not to many + if (fNDCTracks < fNTracksMaxFP) { + sptracks = 0; // Number of tracks with this seed + stub_tracks[sptracks++] = fNDCTracks; + THcDCTrack* theDCTrack = new ((*fDCTracks)[fNDCTracks++]) THcDCTrack(fNPlanes); + theDCTrack->AddSpacePoint(sp1); + theDCTrack->AddSpacePoint(sp2); + if (sp1->fNChamber == 1) + theDCTrack->SetSp1_ID(sp1->fNChamber_spnum); + if (sp1->fNChamber == 2) + theDCTrack->SetSp2_ID(sp1->fNChamber_spnum); + if (sp2->fNChamber == 1) + theDCTrack->SetSp1_ID(sp2->fNChamber_spnum); + if (sp2->fNChamber == 2) + theDCTrack->SetSp2_ID(sp2->fNChamber_spnum); + newtrack = 0; // Make no more tracks in this loop + // (But could replace a SP?) + } else { if (fHMSStyleChambers) { - fNDCTracks=0; - return; + fNDCTracks = 0; + return; } - } - } else { - // Check if there is another space point in the same chamber - for(Int_t itrack=0;itrack<sptracks;itrack++) { - Int_t track=stub_tracks[itrack]; - THcDCTrack *theDCTrack = static_cast<THcDCTrack*>( fDCTracks->At(track)); - Int_t spoint=-1; - Int_t duppoint=0; - for(Int_t isp=0;isp<theDCTrack->GetNSpacePoints();isp++) { - // isp is index of space points in theDCTrack - if(sp2->fNChamber == - theDCTrack->GetSpacePoint(isp)->fNChamber) { - spoint=isp; - } - if(sp2==theDCTrack->GetSpacePoint(isp)) { - duppoint=1; - } - } // End loop over sp in tracks with isp1 - // If there is no other space point in this chamber - // add this space point to current track(2) - if(!duppoint) { - if(spoint<0) { - theDCTrack->AddSpacePoint(sp2); - if (sp2->fNChamber==1) theDCTrack->SetSp1_ID(sp2->fNChamber_spnum); - if (sp2->fNChamber==2) theDCTrack->SetSp2_ID(sp2->fNChamber_spnum); - } else { - // If there is another point in the same chamber - // in this track create a new track with all the - // same space points except spoint - if(fNDCTracks < MAXTRACKS) { - stub_tracks[sptracks++] = fNDCTracks; - THcDCTrack *newDCTrack = new( (*fDCTracks)[fNDCTracks++]) THcDCTrack(fNPlanes); - for(Int_t isp=0;isp<theDCTrack->GetNSpacePoints();isp++) { - if(isp!=spoint) { - newDCTrack->AddSpacePoint(theDCTrack->GetSpacePoint(isp)); - if (theDCTrack->GetSpacePoint(isp)->fNChamber==1) newDCTrack->SetSp1_ID(theDCTrack->GetSpacePoint(isp)->fNChamber_spnum); - if (theDCTrack->GetSpacePoint(isp)->fNChamber==2) newDCTrack->SetSp2_ID(theDCTrack->GetSpacePoint(isp)->fNChamber_spnum); - } else { - newDCTrack->AddSpacePoint(sp2); - if (sp2->fNChamber==1) newDCTrack->SetSp1_ID(sp2->fNChamber_spnum); - if (sp2->fNChamber==2) newDCTrack->SetSp2_ID(sp2->fNChamber_spnum); - } // End check for dup on copy - } // End copy of track - } else { - if (fHMSStyleChambers) { - if (fdebuglinkstubs) cout << "EPIC FAIL 2: Too many tracks found in THcDC::LinkStubs maxtracks = " << MAXTRACKS << endl; - fNDCTracks=0; - return; // Max # of allowed tracks + } + } else { + // Check if there is another space point in the same chamber + for (Int_t itrack = 0; itrack < sptracks; itrack++) { + Int_t track = stub_tracks[itrack]; + THcDCTrack* theDCTrack = static_cast<THcDCTrack*>(fDCTracks->At(track)); + Int_t spoint = -1; + Int_t duppoint = 0; + for (Int_t isp = 0; isp < theDCTrack->GetNSpacePoints(); isp++) { + // isp is index of space points in theDCTrack + if (sp2->fNChamber == theDCTrack->GetSpacePoint(isp)->fNChamber) { + spoint = isp; + } + if (sp2 == theDCTrack->GetSpacePoint(isp)) { + duppoint = 1; + } + } // End loop over sp in tracks with isp1 + // If there is no other space point in this chamber + // add this space point to current track(2) + if (!duppoint) { + if (spoint < 0) { + theDCTrack->AddSpacePoint(sp2); + if (sp2->fNChamber == 1) + theDCTrack->SetSp1_ID(sp2->fNChamber_spnum); + if (sp2->fNChamber == 2) + theDCTrack->SetSp2_ID(sp2->fNChamber_spnum); + } else { + // If there is another point in the same chamber + // in this track create a new track with all the + // same space points except spoint + if (fNDCTracks < MAXTRACKS) { + stub_tracks[sptracks++] = fNDCTracks; + THcDCTrack* newDCTrack = + new ((*fDCTracks)[fNDCTracks++]) THcDCTrack(fNPlanes); + for (Int_t isp = 0; isp < theDCTrack->GetNSpacePoints(); isp++) { + if (isp != spoint) { + newDCTrack->AddSpacePoint(theDCTrack->GetSpacePoint(isp)); + if (theDCTrack->GetSpacePoint(isp)->fNChamber == 1) + newDCTrack->SetSp1_ID( + theDCTrack->GetSpacePoint(isp)->fNChamber_spnum); + if (theDCTrack->GetSpacePoint(isp)->fNChamber == 2) + newDCTrack->SetSp2_ID( + theDCTrack->GetSpacePoint(isp)->fNChamber_spnum); + } else { + newDCTrack->AddSpacePoint(sp2); + if (sp2->fNChamber == 1) + newDCTrack->SetSp1_ID(sp2->fNChamber_spnum); + if (sp2->fNChamber == 2) + newDCTrack->SetSp2_ID(sp2->fNChamber_spnum); + } // End check for dup on copy + } // End copy of track + } else { + if (fHMSStyleChambers) { + if (fdebuglinkstubs) + cout << "EPIC FAIL 2: Too many tracks found in THcDC::LinkStubs " + "maxtracks = " + << MAXTRACKS << endl; + fNDCTracks = 0; + return; // Max # of allowed tracks } - } - } // end if on same chamber - } // end if on duplicate point - } // end for over tracks with isp1 - } // else newtrack - } // criterion - } // end test on same chamber - } // end isp2 loop over new space points - } // end test on tryflag - } // end isp1 outer loop over space points + } + } // end if on same chamber + } // end if on duplicate point + } // end for over tracks with isp1 + } // else newtrack + } // criterion + } // end test on same chamber + } // end isp2 loop over new space points + } // end test on tryflag + } // end isp1 outer loop over space points + // // - // } else { // Make track out of each single space point - for(Int_t isp=0;isp<fNSp;isp++) { - if(fNDCTracks<MAXTRACKS) { - // Need some constructed t thingy + for (Int_t isp = 0; isp < fNSp; isp++) { + if (fNDCTracks < MAXTRACKS) { + // Need some constructed t thingy if (fSp[isp]->GetSetStubFlag()) { - THcDCTrack *newDCTrack = new( (*fDCTracks)[fNDCTracks++]) THcDCTrack(fNPlanes); - newDCTrack->AddSpacePoint(fSp[isp]); - } + THcDCTrack* newDCTrack = new ((*fDCTracks)[fNDCTracks++]) THcDCTrack(fNPlanes); + newDCTrack->AddSpacePoint(fSp[isp]); + } } else { - if (fdebuglinkstubs) cout << "EPIC FAIL 3: Too many tracks found in THcDC::LinkStubs" << endl; - fNDCTracks=0; - // Do something here to fail this event - return; // Max # of allowed tracks + if (fdebuglinkstubs) + cout << "EPIC FAIL 3: Too many tracks found in THcDC::LinkStubs" << endl; + fNDCTracks = 0; + // Do something here to fail this event + return; // Max # of allowed tracks } } } /// if (fdebuglinkstubs) { cout << " Number of tracks from link stubs = " << fNDCTracks << endl; - printf("%s %s \n","Track","Plane Wire "); - for (UInt_t itrack=0;itrack<fNDCTracks;itrack++) { - THcDCTrack *tempTrack = (THcDCTrack*)( fDCTracks->At(itrack)); - printf("%-5d ",itrack+1); - for (Int_t ihit=0;ihit<tempTrack->GetNHits();ihit++) { - THcDCHit* hit=(THcDCHit*)(tempTrack->GetHit(ihit)); - printf("%3d %3d",hit->GetPlaneNum(),hit->GetWireNum()); + printf("%s %s \n", "Track", "Plane Wire "); + for (UInt_t itrack = 0; itrack < fNDCTracks; itrack++) { + THcDCTrack* tempTrack = (THcDCTrack*)(fDCTracks->At(itrack)); + printf("%-5d ", itrack + 1); + for (Int_t ihit = 0; ihit < tempTrack->GetNHits(); ihit++) { + THcDCHit* hit = (THcDCHit*)(tempTrack->GetHit(ihit)); + printf("%3d %3d", hit->GetPlaneNum(), hit->GetWireNum()); } printf("\n"); } @@ -934,123 +1023,116 @@ void THcDC::LinkStubs() } //_____________________________________________________________________________ -void THcDC::TrackFit() -{ +void THcDC::TrackFit() { /** Primary track fitting routine */ // Number of ray parameters in focal plane. - const Int_t raycoeffmap[]={4,5,2,3}; + const Int_t raycoeffmap[] = {4, 5, 2, 3}; Double_t dummychi2 = 1.0E4; - for(UInt_t itrack=0;itrack<fNDCTracks;itrack++) { + for (UInt_t itrack = 0; itrack < fNDCTracks; itrack++) { // Double_t chi2 = dummychi2; // Int_t htrack_fit_num = itrack; - THcDCTrack *theDCTrack = static_cast<THcDCTrack*>( fDCTracks->At(itrack)); + THcDCTrack* theDCTrack = static_cast<THcDCTrack*>(fDCTracks->At(itrack)); Double_t coords[theDCTrack->GetNHits()]; - Int_t planes[theDCTrack->GetNHits()]; - for(Int_t ihit=0;ihit < theDCTrack->GetNHits();ihit++) { - THcDCHit* hit=theDCTrack->GetHit(ihit); - planes[ihit]=hit->GetPlaneNum()-1; - if(fFixLR) { - if(fFixPropagationCorrection) { - coords[ihit] = hit->GetPos() - + theDCTrack->GetHitLR(ihit)*theDCTrack->GetHitDist(ihit); - } else { - coords[ihit] = hit->GetPos() - + theDCTrack->GetHitLR(ihit)*hit->GetDist(); - } + Int_t planes[theDCTrack->GetNHits()]; + for (Int_t ihit = 0; ihit < theDCTrack->GetNHits(); ihit++) { + THcDCHit* hit = theDCTrack->GetHit(ihit); + planes[ihit] = hit->GetPlaneNum() - 1; + if (fFixLR) { + if (fFixPropagationCorrection) { + coords[ihit] = hit->GetPos() + theDCTrack->GetHitLR(ihit) * theDCTrack->GetHitDist(ihit); + } else { + coords[ihit] = hit->GetPos() + theDCTrack->GetHitLR(ihit) * hit->GetDist(); + } } else { - if(fFixPropagationCorrection) { - coords[ihit] = hit->GetPos() - + hit->GetLR()*theDCTrack->GetHitDist(ihit); - } else { - coords[ihit] = hit->GetCoord(); - } + if (fFixPropagationCorrection) { + coords[ihit] = hit->GetPos() + hit->GetLR() * theDCTrack->GetHitDist(ihit); + } else { + coords[ihit] = hit->GetCoord(); + } } - - } //end loop over hits + } // end loop over hits theDCTrack->SetNFree(theDCTrack->GetNHits() - NUM_FPRAY); Double_t chi2 = dummychi2; - if(theDCTrack->GetNFree() > 0) { + if (theDCTrack->GetNFree() > 0) { TVectorD TT(NUM_FPRAY); - TMatrixD AA(NUM_FPRAY,NUM_FPRAY); - for(Int_t irayp=0;irayp<NUM_FPRAY;irayp++) { - TT[irayp] = 0.0; - for(Int_t ihit=0;ihit < theDCTrack->GetNHits();ihit++) { - - THcDCHit* hit=theDCTrack->GetHit(ihit); - - TT[irayp] += (coords[ihit]*fPlaneCoeffs[planes[ihit]][raycoeffmap[irayp]])/pow(hit->GetWireSigma(),2); - // if (hit->GetPlaneNum()==5) - // { - // // cout << "Plane: " << hit->GetPlaneNum() << endl; - // //cout << "Wire: " <<hit->GetWireNum() << endl; - // //cout << "Sigma: " << hit->GetWireSigma() << endl; - // } - - } //end hit loop + TMatrixD AA(NUM_FPRAY, NUM_FPRAY); + for (Int_t irayp = 0; irayp < NUM_FPRAY; irayp++) { + TT[irayp] = 0.0; + for (Int_t ihit = 0; ihit < theDCTrack->GetNHits(); ihit++) { + + THcDCHit* hit = theDCTrack->GetHit(ihit); + + TT[irayp] += (coords[ihit] * fPlaneCoeffs[planes[ihit]][raycoeffmap[irayp]]) / + pow(hit->GetWireSigma(), 2); + // if (hit->GetPlaneNum()==5) + // { + // // cout << "Plane: " << hit->GetPlaneNum() << endl; + // //cout << "Wire: " <<hit->GetWireNum() << endl; + // //cout << "Sigma: " << hit->GetWireSigma() << endl; + // } + + } // end hit loop } - for(Int_t irayp=0;irayp<NUM_FPRAY;irayp++) { - for(Int_t jrayp=0;jrayp<NUM_FPRAY;jrayp++) { - AA[irayp][jrayp] = 0.0; - if(jrayp<irayp) { // Symmetric - AA[irayp][jrayp] = AA[jrayp][irayp]; - } else { - for(Int_t ihit=0;ihit < theDCTrack->GetNHits();ihit++) { - - THcDCHit* hit=theDCTrack->GetHit(ihit); - - - AA[irayp][jrayp] += fPlaneCoeffs[planes[ihit]][raycoeffmap[irayp]]* - fPlaneCoeffs[planes[ihit]][raycoeffmap[jrayp]]/ - pow(hit->GetWireSigma(),2); - - } //end ihit loop - } - } + for (Int_t irayp = 0; irayp < NUM_FPRAY; irayp++) { + for (Int_t jrayp = 0; jrayp < NUM_FPRAY; jrayp++) { + AA[irayp][jrayp] = 0.0; + if (jrayp < irayp) { // Symmetric + AA[irayp][jrayp] = AA[jrayp][irayp]; + } else { + for (Int_t ihit = 0; ihit < theDCTrack->GetNHits(); ihit++) { + + THcDCHit* hit = theDCTrack->GetHit(ihit); + + AA[irayp][jrayp] += fPlaneCoeffs[planes[ihit]][raycoeffmap[irayp]] * + fPlaneCoeffs[planes[ihit]][raycoeffmap[jrayp]] / + pow(hit->GetWireSigma(), 2); + + } // end ihit loop + } + } } // Solve 4x4 equations TVectorD dray(NUM_FPRAY); // Should check that it is invertable AA.Invert(); - dray = AA*TT; - // cout << "DRAY: " << dray[0] << " "<< dray[1] << " "<< dray[2] << " "<< dray[3] << " " << endl; - // if(bad_determinant) { + dray = AA * TT; + // cout << "DRAY: " << dray[0] << " "<< dray[1] << " "<< dray[2] << " "<< dray[3] << " " + // << endl; if(bad_determinant) { // dray[0] = dray[1] = 10000.; dray[2] = dray[3] = 2.0; // } // Calculate hit coordinate for each plane for chi2 and efficiency // calculations // Make sure fCoords, fResiduals, and fDoubleResiduals are clear - for(Int_t iplane=0;iplane < fNPlanes; iplane++) { - Double_t coord=0.0; - for(Int_t ir=0;ir<NUM_FPRAY;ir++) { - coord += fPlaneCoeffs[iplane][raycoeffmap[ir]]*dray[ir]; - // cout << "ir = " << ir << ", dray[ir] = " << dray[ir] << endl; - } - theDCTrack->SetCoord(iplane,coord); + for (Int_t iplane = 0; iplane < fNPlanes; iplane++) { + Double_t coord = 0.0; + for (Int_t ir = 0; ir < NUM_FPRAY; ir++) { + coord += fPlaneCoeffs[iplane][raycoeffmap[ir]] * dray[ir]; + // cout << "ir = " << ir << ", dray[ir] = " << dray[ir] << endl; + } + theDCTrack->SetCoord(iplane, coord); } // Compute Chi2 and residuals chi2 = 0.0; - for(Int_t ihit=0;ihit < theDCTrack->GetNHits();ihit++) { - - THcDCHit* hit=theDCTrack->GetHit(ihit); - + for (Int_t ihit = 0; ihit < theDCTrack->GetNHits(); ihit++) { - Double_t residual = coords[ihit] - theDCTrack->GetCoord(planes[ihit]); - theDCTrack->SetResidual(planes[ihit], residual); + THcDCHit* hit = theDCTrack->GetHit(ihit); - // double track_coord = theDCTrack->GetCoord(planes[ihit]); -//cout<<planes[ihit]<<"\t"<<track_coord<<"\t"<<coords[ihit]<<"\t"<<residual<<endl; - chi2 += pow(residual/hit->GetWireSigma(),2); + Double_t residual = coords[ihit] - theDCTrack->GetCoord(planes[ihit]); + theDCTrack->SetResidual(planes[ihit], residual); + // double track_coord = theDCTrack->GetCoord(planes[ihit]); + // cout<<planes[ihit]<<"\t"<<track_coord<<"\t"<<coords[ihit]<<"\t"<<residual<<endl; + chi2 += pow(residual / hit->GetWireSigma(), 2); } theDCTrack->SetVector(dray[0], dray[1], 0.0, dray[2], dray[3]); @@ -1058,181 +1140,171 @@ void THcDC::TrackFit() theDCTrack->SetChisq(chi2); // calculate ray without a plane in track - for(Int_t ipl_hit=0;ipl_hit < theDCTrack->GetNHits();ipl_hit++) { - - - if(theDCTrack->GetNFree() > 0) { - TVectorD TT(NUM_FPRAY); - TMatrixD AA(NUM_FPRAY,NUM_FPRAY); - for(Int_t irayp=0;irayp<NUM_FPRAY;irayp++) { - TT[irayp] = 0.0; - for(Int_t ihit=0;ihit < theDCTrack->GetNHits();ihit++) { - - - THcDCHit* hit=theDCTrack->GetHit(ihit); - - if (ihit != ipl_hit) { - TT[irayp] += (coords[ihit]* - fPlaneCoeffs[planes[ihit]][raycoeffmap[irayp]]) - /pow(hit->GetWireSigma(),2); - - } - } - } - for(Int_t irayp=0;irayp<NUM_FPRAY;irayp++) { - for(Int_t jrayp=0;jrayp<NUM_FPRAY;jrayp++) { - AA[irayp][jrayp] = 0.0; - if(jrayp<irayp) { // Symmetric - AA[irayp][jrayp] = AA[jrayp][irayp]; - } else { - - for(Int_t ihit=0;ihit < theDCTrack->GetNHits();ihit++) { - - THcDCHit* hit=theDCTrack->GetHit(ihit); - - - if (ihit != ipl_hit) { - AA[irayp][jrayp] += fPlaneCoeffs[planes[ihit]][raycoeffmap[irayp]]* - fPlaneCoeffs[planes[ihit]][raycoeffmap[jrayp]]/ - pow(hit->GetWireSigma(),2); - - } - } - } - } - } - // - // Solve 4x4 equations - // Should check that it is invertable - TVectorD dray(NUM_FPRAY); - AA.Invert(); - dray = AA*TT; - Double_t coord=0.0; - for(Int_t ir=0;ir<NUM_FPRAY;ir++) { - coord += fPlaneCoeffs[planes[ipl_hit]][raycoeffmap[ir]]*dray[ir]; - // cout << "ir = " << ir << ", dray[ir] = " << dray[ir] << endl; - } - Double_t residual = coords[ipl_hit] - coord; - theDCTrack->SetResidualExclPlane(planes[ipl_hit], residual); + for (Int_t ipl_hit = 0; ipl_hit < theDCTrack->GetNHits(); ipl_hit++) { + + if (theDCTrack->GetNFree() > 0) { + TVectorD TT(NUM_FPRAY); + TMatrixD AA(NUM_FPRAY, NUM_FPRAY); + for (Int_t irayp = 0; irayp < NUM_FPRAY; irayp++) { + TT[irayp] = 0.0; + for (Int_t ihit = 0; ihit < theDCTrack->GetNHits(); ihit++) { + + THcDCHit* hit = theDCTrack->GetHit(ihit); + + if (ihit != ipl_hit) { + TT[irayp] += (coords[ihit] * fPlaneCoeffs[planes[ihit]][raycoeffmap[irayp]]) / + pow(hit->GetWireSigma(), 2); + } + } + } + for (Int_t irayp = 0; irayp < NUM_FPRAY; irayp++) { + for (Int_t jrayp = 0; jrayp < NUM_FPRAY; jrayp++) { + AA[irayp][jrayp] = 0.0; + if (jrayp < irayp) { // Symmetric + AA[irayp][jrayp] = AA[jrayp][irayp]; + } else { + + for (Int_t ihit = 0; ihit < theDCTrack->GetNHits(); ihit++) { + + THcDCHit* hit = theDCTrack->GetHit(ihit); + + if (ihit != ipl_hit) { + AA[irayp][jrayp] += fPlaneCoeffs[planes[ihit]][raycoeffmap[irayp]] * + fPlaneCoeffs[planes[ihit]][raycoeffmap[jrayp]] / + pow(hit->GetWireSigma(), 2); + } + } + } + } + } + // + // Solve 4x4 equations + // Should check that it is invertable + TVectorD dray(NUM_FPRAY); + AA.Invert(); + dray = AA * TT; + Double_t coord = 0.0; + for (Int_t ir = 0; ir < NUM_FPRAY; ir++) { + coord += fPlaneCoeffs[planes[ipl_hit]][raycoeffmap[ir]] * dray[ir]; + // cout << "ir = " << ir << ", dray[ir] = " << dray[ir] << endl; + } + Double_t residual = coords[ipl_hit] - coord; + theDCTrack->SetResidualExclPlane(planes[ipl_hit], residual); } } } - //Calculate residual without plane + // Calculate residual without plane // Calculate residuals for each chamber if in single stub mode // and there was a track found in each chamber // Specific for two chambers. Can/should it be generalized? - if(fSingleStub != 0) { - if(fNDCTracks == 2) { - THcDCTrack *theDCTrack1 = static_cast<THcDCTrack*>( fDCTracks->At(0)); - THcDCTrack *theDCTrack2 = static_cast<THcDCTrack*>( fDCTracks->At(1)); + if (fSingleStub != 0) { + if (fNDCTracks == 2) { + THcDCTrack* theDCTrack1 = static_cast<THcDCTrack*>(fDCTracks->At(0)); + THcDCTrack* theDCTrack2 = static_cast<THcDCTrack*>(fDCTracks->At(1)); // Int_t itrack=0; - Int_t ihit=0; - THcDCHit* hit=theDCTrack1->GetHit(ihit); - Int_t plane=hit->GetPlaneNum()-1; - Int_t chamber=fNChamber[plane]; - if(chamber==1) { - // itrack=1; - hit=theDCTrack2->GetHit(ihit); - plane=hit->GetPlaneNum()-1; - chamber=fNChamber[plane]; - if(chamber==2) { - Double_t ray1[4]; - Double_t ray2[4]; - theDCTrack1->GetRay(ray1); - theDCTrack2->GetRay(ray2); - // itrack = 1; - // Loop over hits in second chamber - for(Int_t ihit=0;ihit < theDCTrack2->GetNHits();ihit++) { - // Calculate residual in second chamber from first chamber track - THcDCHit* hit=theDCTrack2->GetHit(ihit); - Int_t plane=hit->GetPlaneNum()-1; - Double_t pos = DpsiFun(ray1,plane); - Double_t coord; - if(fFixLR) { - if(fFixPropagationCorrection) { - coord = hit->GetPos() - + theDCTrack2->GetHitLR(ihit)*theDCTrack2->GetHitDist(ihit); - } else { - coord = hit->GetPos() - + theDCTrack2->GetHitLR(ihit)*hit->GetDist(); - } - } else { - if(fFixPropagationCorrection) { - coord = hit->GetPos() - + hit->GetLR()*theDCTrack2->GetHitDist(ihit); - } else { - coord = hit->GetCoord(); - } - } - theDCTrack1->SetDoubleResidual(plane,coord - pos); - // hdc_dbl_res(pln) = hdc_double_residual(1,pln) for hists - } - // itrack=0; - // Loop over hits in first chamber - for(Int_t ihit=0;ihit < theDCTrack1->GetNHits();ihit++) { - // Calculate residual in first chamber from second chamber track - THcDCHit* hit=theDCTrack1->GetHit(ihit); - Int_t plane=hit->GetPlaneNum()-1; - Double_t pos = DpsiFun(ray1,plane); - Double_t coord; - if(fFixLR) { - if(fFixPropagationCorrection) { - coord = hit->GetPos() - + theDCTrack1->GetHitLR(ihit)*theDCTrack1->GetHitDist(ihit); - } else { - coord = hit->GetPos() - + theDCTrack1->GetHitLR(ihit)*hit->GetDist(); - } - } else { - if(fFixPropagationCorrection) { - coord = hit->GetPos() - + hit->GetLR()*theDCTrack1->GetHitDist(ihit); - } else { - coord = hit->GetCoord(); - } - } - theDCTrack2->SetDoubleResidual(plane,coord - pos); - // hdc_dbl_res(pln) = hdc_double_residual(1,pln) for hists - } - } + Int_t ihit = 0; + THcDCHit* hit = theDCTrack1->GetHit(ihit); + Int_t plane = hit->GetPlaneNum() - 1; + Int_t chamber = fNChamber[plane]; + if (chamber == 1) { + // itrack=1; + hit = theDCTrack2->GetHit(ihit); + plane = hit->GetPlaneNum() - 1; + chamber = fNChamber[plane]; + if (chamber == 2) { + Double_t ray1[4]; + Double_t ray2[4]; + theDCTrack1->GetRay(ray1); + theDCTrack2->GetRay(ray2); + // itrack = 1; + // Loop over hits in second chamber + for (Int_t ihit = 0; ihit < theDCTrack2->GetNHits(); ihit++) { + // Calculate residual in second chamber from first chamber track + THcDCHit* hit = theDCTrack2->GetHit(ihit); + Int_t plane = hit->GetPlaneNum() - 1; + Double_t pos = DpsiFun(ray1, plane); + Double_t coord; + if (fFixLR) { + if (fFixPropagationCorrection) { + coord = hit->GetPos() + theDCTrack2->GetHitLR(ihit) * theDCTrack2->GetHitDist(ihit); + } else { + coord = hit->GetPos() + theDCTrack2->GetHitLR(ihit) * hit->GetDist(); + } + } else { + if (fFixPropagationCorrection) { + coord = hit->GetPos() + hit->GetLR() * theDCTrack2->GetHitDist(ihit); + } else { + coord = hit->GetCoord(); + } + } + theDCTrack1->SetDoubleResidual(plane, coord - pos); + // hdc_dbl_res(pln) = hdc_double_residual(1,pln) for hists + } + // itrack=0; + // Loop over hits in first chamber + for (Int_t ihit = 0; ihit < theDCTrack1->GetNHits(); ihit++) { + // Calculate residual in first chamber from second chamber track + THcDCHit* hit = theDCTrack1->GetHit(ihit); + Int_t plane = hit->GetPlaneNum() - 1; + Double_t pos = DpsiFun(ray1, plane); + Double_t coord; + if (fFixLR) { + if (fFixPropagationCorrection) { + coord = hit->GetPos() + theDCTrack1->GetHitLR(ihit) * theDCTrack1->GetHitDist(ihit); + } else { + coord = hit->GetPos() + theDCTrack1->GetHitLR(ihit) * hit->GetDist(); + } + } else { + if (fFixPropagationCorrection) { + coord = hit->GetPos() + hit->GetLR() * theDCTrack1->GetHitDist(ihit); + } else { + coord = hit->GetCoord(); + } + } + theDCTrack2->SetDoubleResidual(plane, coord - pos); + // hdc_dbl_res(pln) = hdc_double_residual(1,pln) for hists + } + } } } } // if (fdebugtrackprint) { - printf("%5s %-14s %-14s %-14s %-14s %-10s %-10s \n","Track","x_t","y_t","xp_t","yp_t","chi2","DOF"); - printf("%5s %-14s %-14s %-14s %-14s %-10s %-10s \n"," ","[cm]","[cm]","[rad]","[rad]"," "," "); - for(UInt_t itr=0;itr < fNDCTracks;itr++) { - THcDCTrack *theDCTrack = static_cast<THcDCTrack*>( fDCTracks->At(itr)); - printf("%-5d %14.6e %14.6e %14.6e %14.6e %10.3e %3d \n", itr+1,theDCTrack->GetX(),theDCTrack->GetY(),theDCTrack->GetXP(),theDCTrack->GetYP(),theDCTrack->GetChisq(),theDCTrack->GetNFree()); + printf("%5s %-14s %-14s %-14s %-14s %-10s %-10s \n", "Track", "x_t", "y_t", "xp_t", "yp_t", + "chi2", "DOF"); + printf("%5s %-14s %-14s %-14s %-14s %-10s %-10s \n", " ", "[cm]", "[cm]", "[rad]", "[rad]", + " ", " "); + for (UInt_t itr = 0; itr < fNDCTracks; itr++) { + THcDCTrack* theDCTrack = static_cast<THcDCTrack*>(fDCTracks->At(itr)); + printf("%-5d %14.6e %14.6e %14.6e %14.6e %10.3e %3d \n", itr + 1, theDCTrack->GetX(), + theDCTrack->GetY(), theDCTrack->GetXP(), theDCTrack->GetYP(), theDCTrack->GetChisq(), + theDCTrack->GetNFree()); } - for(UInt_t itr=0;itr < fNDCTracks;itr++) { - printf("%s %5d \n","Hit info for track number = ",itr+1); - printf("%5s %-15s %-15s %-15s \n","Plane","WIRE_COORD","Fit postiion","Residual"); - THcDCTrack *theDCTrack = static_cast<THcDCTrack*>( fDCTracks->At(itr)); - for(Int_t ihit=0;ihit < theDCTrack->GetNHits();ihit++) { - THcDCHit* hit=theDCTrack->GetHit(ihit); - Int_t plane=hit->GetPlaneNum()-1; - Double_t coords_temp; - if(fFixLR) { - if(fFixPropagationCorrection) { - coords_temp = hit->GetPos() - + theDCTrack->GetHitLR(ihit)*theDCTrack->GetHitDist(ihit); - } else { - coords_temp = hit->GetPos() - + theDCTrack->GetHitLR(ihit)*hit->GetDist(); - } - } else { - if(fFixPropagationCorrection) { - coords_temp = hit->GetPos() - + hit->GetLR()*theDCTrack->GetHitDist(ihit); - } else { - coords_temp = hit->GetCoord(); - } - } - printf("%-5d %15.7e %15.7e %15.7e \n",plane+1,coords_temp,theDCTrack->GetCoord(plane),theDCTrack->GetResidual(plane)); + for (UInt_t itr = 0; itr < fNDCTracks; itr++) { + printf("%s %5d \n", "Hit info for track number = ", itr + 1); + printf("%5s %-15s %-15s %-15s \n", "Plane", "WIRE_COORD", "Fit postiion", "Residual"); + THcDCTrack* theDCTrack = static_cast<THcDCTrack*>(fDCTracks->At(itr)); + for (Int_t ihit = 0; ihit < theDCTrack->GetNHits(); ihit++) { + THcDCHit* hit = theDCTrack->GetHit(ihit); + Int_t plane = hit->GetPlaneNum() - 1; + Double_t coords_temp; + if (fFixLR) { + if (fFixPropagationCorrection) { + coords_temp = hit->GetPos() + theDCTrack->GetHitLR(ihit) * theDCTrack->GetHitDist(ihit); + } else { + coords_temp = hit->GetPos() + theDCTrack->GetHitLR(ihit) * hit->GetDist(); + } + } else { + if (fFixPropagationCorrection) { + coords_temp = hit->GetPos() + hit->GetLR() * theDCTrack->GetHitDist(ihit); + } else { + coords_temp = hit->GetCoord(); + } + } + printf("%-5d %15.7e %15.7e %15.7e \n", plane + 1, coords_temp, theDCTrack->GetCoord(plane), + theDCTrack->GetResidual(plane)); } } } @@ -1241,8 +1313,7 @@ void THcDC::TrackFit() } // // -Double_t THcDC::DpsiFun(Double_t ray[4], Int_t plane) -{ +Double_t THcDC::DpsiFun(Double_t ray[4], Int_t plane) { /** this function calculates the psi coordinate of the intersection of a ray (defined by ray) with a hms wire chamber plane. the geometry @@ -1261,74 +1332,73 @@ Double_t THcDC::DpsiFun(Double_t ray[4], Int_t plane) ray(4) = tan(yp) */ - Double_t infinity = 1.0E+20; - Double_t cinfinity = 1/infinity; - Double_t DpsiFun = - ray[2]*ray[1]*fPlaneCoeffs[plane][0] + - ray[3]*ray[0]*fPlaneCoeffs[plane][1] + - ray[2]*fPlaneCoeffs[plane][2] + - ray[3]*fPlaneCoeffs[plane][3] + - ray[0]*fPlaneCoeffs[plane][4] + - ray[1]*fPlaneCoeffs[plane][5]; - Double_t denom = ray[2]*fPlaneCoeffs[plane][6] - + ray[3]*fPlaneCoeffs[plane][7] - + fPlaneCoeffs[plane][8]; - if(TMath::Abs(denom) < cinfinity) { + Double_t infinity = 1.0E+20; + Double_t cinfinity = 1 / infinity; + Double_t DpsiFun = ray[2] * ray[1] * fPlaneCoeffs[plane][0] + + ray[3] * ray[0] * fPlaneCoeffs[plane][1] + ray[2] * fPlaneCoeffs[plane][2] + + ray[3] * fPlaneCoeffs[plane][3] + ray[0] * fPlaneCoeffs[plane][4] + + ray[1] * fPlaneCoeffs[plane][5]; + Double_t denom = + ray[2] * fPlaneCoeffs[plane][6] + ray[3] * fPlaneCoeffs[plane][7] + fPlaneCoeffs[plane][8]; + if (TMath::Abs(denom) < cinfinity) { DpsiFun = infinity; } else { - DpsiFun = DpsiFun/denom; + DpsiFun = DpsiFun / denom; } - return(DpsiFun); + return (DpsiFun); } //_____________________________________________________________________________ -Int_t THcDC::End(THaRunBase* run) -{ +Int_t THcDC::End(THaRunBase* run) { // EffCalc(); MissReport(Form("%s.%s", GetApparatus()->GetName(), GetName())); return 0; } //_____________________________________________________________________________ -void THcDC::EffInit() -{ +void THcDC::EffInit() { /** Create, and initialize counters used to calculate efficiencies. Register the counters in gHcParms so that the variables can be used in end of run reports. */ - delete [] fNChamHits; fNChamHits = new Int_t [fNChambers]; - delete [] fPlaneEvents; fPlaneEvents = new Int_t [fNPlanes]; + delete[] fNChamHits; + fNChamHits = new Int_t[fNChambers]; + delete[] fPlaneEvents; + fPlaneEvents = new Int_t[fNPlanes]; fTotEvents = 0; - for(UInt_t i=0;i<fNChambers;i++) { + for (UInt_t i = 0; i < fNChambers; i++) { fNChamHits[i] = 0; } - for(Int_t i=0;i<fNPlanes;i++) { + for (Int_t i = 0; i < fNPlanes; i++) { fPlaneEvents[i] = 0; } - gHcParms->Define(Form("%sdc_tot_events",fPrefix),"Total DC Events",fTotEvents); - gHcParms->Define(Form("%sdc_cham_hits[%d]",fPrefix,fNChambers),"N events with hits per chamber",*fNChamHits); - gHcParms->Define(Form("%sdc_events[%d]",fPrefix,fNPlanes),"N events with hits per plane",*fPlaneEvents); + gHcParms->Define(Form("%sdc_tot_events", fPrefix), "Total DC Events", fTotEvents); + gHcParms->Define(Form("%sdc_cham_hits[%d]", fPrefix, fNChambers), + "N events with hits per chamber", *fNChamHits); + gHcParms->Define(Form("%sdc_events[%d]", fPrefix, fNPlanes), "N events with hits per plane", + *fPlaneEvents); } //_____________________________________________________________________________ -void THcDC::Eff() -{ +void THcDC::Eff() { /** Accumulate statistics for efficiency calculations */ fTotEvents++; - for(UInt_t i=0;i<fNChambers;i++) { - if(fChambers[i]->GetNHits()>0) fNChamHits[i]++; + for (UInt_t i = 0; i < fNChambers; i++) { + if (fChambers[i]->GetNHits() > 0) + fNChamHits[i]++; } - for(Int_t i=0;i<fNPlanes;i++) { - if(fPlanes[i]->GetNHits() > 0) fPlaneEvents[i]++; + for (Int_t i = 0; i < fNPlanes; i++) { + if (fPlanes[i]->GetNHits() > 0) + fPlaneEvents[i]++; } return; } ClassImp(THcDC) -//////////////////////////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////////////////////////// diff --git a/src/THcDC.h b/src/THcDC.h index f0100cdf87115c8cdef3ab3952c3fb0239e2d953..f4424f5efcb9dd205a7b9b73a4166e345e98e365 100644 --- a/src/THcDC.h +++ b/src/THcDC.h @@ -15,20 +15,50 @@ #include "THcDriftChamber.h" #include "TMath.h" +#include <map> +#include "hcana/Logger.h" + #define NUM_FPRAY 4 +namespace hallc { + namespace data { + + /** Drift chamber data. + * Currently just for testing + */ + struct DriftChamber { + + // Plane number + std::map<int,double> _Residuals; + std::map<int,double> _ResidualsExclPlane; + std::map<int,double> _Wire_hit_did; + std::map<int,double> _Wire_hit_should; + + ClassDef(DriftChamber,1) + }; + + } // namespace data +} + //class THaScCalib; class TClonesArray; class THcDC : public THaTrackingDetector, public THcHitList { +protected: + std::shared_ptr<spdlog::logger> _sub_logger; //! + public: + + hallc::data::DriftChamber _basic_data; + THcDC( const char* name, const char* description = "", THaApparatus* a = NULL ); virtual ~THcDC(); virtual Int_t Decode( const THaEvData& ); virtual EStatus Init( const TDatime& run_time ); + virtual Int_t ManualInitTree( TTree* t ); virtual Int_t End(THaRunBase* run=0); virtual Int_t CoarseTrack( TClonesArray& tracks ); virtual Int_t FineTrack( TClonesArray& tracks ); @@ -37,7 +67,7 @@ public: // Int_t GetNHits() const { return fNhit; } - // Int_t GetNTracks() const { return fNDCTracks; } + Int_t GetNTracks() const { return fNDCTracks; } // const TClonesArray* GetTrackHits() const { return fTrackProj; } void SetFocalPlaneBestTrack(Int_t golden_track_index); // Called in THcHallCSpectrometer: @@ -67,6 +97,8 @@ public: Int_t GetVersion() const {return fVersion;} + + Double_t GetPlaneTimeZero(Int_t plane) const { return fPlaneTimeZero[plane-1];} Double_t GetSigma(Int_t plane) const { return fSigma[plane-1];} Int_t GetFixPropagationCorrectionFlag() const {return fFixPropagationCorrection;} @@ -84,6 +116,7 @@ public: // friend class THaScCalib; THcDC(); // for ROOT I/O + protected: Int_t fdebuglinkstubs; Int_t fdebugprintrawdc; @@ -192,6 +225,15 @@ protected: // Intermediate structure for building static const UInt_t MAXTRACKS = 50; +public: + THcDriftChamberPlane* GetPlane(unsigned int i_plane) { + if(static_cast<int>(i_plane) < fNPlanes) { + return fPlanes[i_plane]; + } + return nullptr; + } + +protected: std::vector<THcDriftChamberPlane*> fPlanes; // List of plane objects std::vector<THcDriftChamber*> fChambers; // List of chamber objects diff --git a/src/THcDetectorMap.cxx b/src/THcDetectorMap.cxx index 6a4a1b207536cc17cd50fe2bd73c6c8a3a70594e..3cdc61d5b529d1800566b8cd221a803280cc330f 100644 --- a/src/THcDetectorMap.cxx +++ b/src/THcDetectorMap.cxx @@ -28,7 +28,7 @@ inline static bool IsComment( const string& s, string::size_type pos ) } //_____________________________________________________________________________ -THcDetectorMap::THcDetectorMap() : fNchans(0), fNIDs(0) +THcDetectorMap::THcDetectorMap() : hcana::ConfigLogging<TObject>(), fNchans(0), fNIDs(0) { } @@ -405,11 +405,14 @@ void THcDetectorMap::Load(const char *fname) fNchans++; } } - cout << endl << " Detector ID Map" << endl << endl; + _logger->info("Detector ID Map"); + //cout << endl << " Detector ID Map" << endl << endl; + for(Int_t i=0; i < fNIDs; i++) { - cout << " "; - cout << fIDMap[i].name << " " << fIDMap[i].id << endl; + //cout << " "; + //cout << fIDMap[i].name << " " << fIDMap[i].id << endl; + _logger->info(" {:<10} {:<10} ", fIDMap[i].name ,fIDMap[i].id ); } - cout << endl; + //cout << endl; } diff --git a/src/THcDetectorMap.h b/src/THcDetectorMap.h index b222cf4173bbfa4de38ef1ac0a4eb9e4c409938e..ccca1927aa3b02457c299fb95c4831e6f141c545 100644 --- a/src/THcDetectorMap.h +++ b/src/THcDetectorMap.h @@ -11,7 +11,9 @@ #include "THaDetMap.h" #include <list> -class THcDetectorMap : public TObject { +#include "hcana/Logger.h" + +class THcDetectorMap : public hcana::ConfigLogging<TObject> { public: THcDetectorMap(); diff --git a/src/THcDriftChamberPlane.cxx b/src/THcDriftChamberPlane.cxx index e9d212a0a6d496325e8dcb55218027ca9d0f7c45..5c1a36fbbbdb3a6254bb4b4aaf61299f7c1e2f4b 100644 --- a/src/THcDriftChamberPlane.cxx +++ b/src/THcDriftChamberPlane.cxx @@ -257,8 +257,7 @@ Int_t THcDriftChamberPlane::ReadDatabase( const TDatime& date ) // For HMS, wire numbers start with one, but arrays start with zero. // So wire number is index+1 for (int i=0; i<nWires; i++) { - Double_t pos = fPitch*( (fWireOrder==0?(i+1):fNWires-i) - - fCentralWire) - fCenter; + Double_t pos = fPitch * ((fWireOrder == 0 ? (i + 1) : fNWires - i) - fCentralWire) - fCenter; Int_t readoutside = GetReadoutSide(i+1); new((*fWires)[i]) THcDCWire( i+1, pos , fTzeroWire[i], fSigmaWire[i], readoutside, fTTDConv); //added fTzeroWire/fSigmaWire to be read in as fTOffset --Carlos } diff --git a/src/THcDriftChamberPlane.h b/src/THcDriftChamberPlane.h index 96fd384cce6e267dd1c3fad8773805b10bb332a9..eaa7b54097a103d71c25e603b409bcc7d1deb94f 100644 --- a/src/THcDriftChamberPlane.h +++ b/src/THcDriftChamberPlane.h @@ -52,6 +52,8 @@ public: { assert( i>=1 && i<=GetNWires() ); return (THcDCWire*)fWires->UncheckedAt(i-1); } + TClonesArray* GetWires() { return fWires; } + Int_t GetNHits() const { return fHits->GetLast()+1; } Int_t GetNRawhits() const {return fNRawhits; } TClonesArray* GetHits() const { return fHits; } diff --git a/src/THcExtTarCor.cxx b/src/THcExtTarCor.cxx index 2ceaa01643421365d57b7b4bec8b140b42a6f99f..03ed4ce58d447d372b12b42d81cca9b16a2cb814 100644 --- a/src/THcExtTarCor.cxx +++ b/src/THcExtTarCor.cxx @@ -23,7 +23,7 @@ using namespace std; //_____________________________________________________________________________ THcExtTarCor::THcExtTarCor( const char* name, const char* description, const char* spectro, const char* vertex ) : - THaExtTarCor(name, description, spectro, vertex) + hcana::ConfigLogging<THaExtTarCor>(name, description, spectro, vertex) { // Normal constructor. @@ -156,9 +156,10 @@ Int_t THcExtTarCor::ReadDatabase( const TDatime& date ) { #ifdef WITH_DEBUG - cout << "In THcExtTarCor::ReadDatabase()" << endl; + //cout << "In THcExtTarCor::ReadDatabase()" << endl; #endif // + _logger->debug("In THcExtTarCor::ReadDatabase()"); // cout << " GetName() " << GetName() << endl; return kOK; diff --git a/src/THcExtTarCor.h b/src/THcExtTarCor.h index 848abfd2cca26a720b8aef94785c7aec3a243101..423f5bd7df945f925ba9d62c8cc06519d9311b9e 100644 --- a/src/THcExtTarCor.h +++ b/src/THcExtTarCor.h @@ -8,10 +8,11 @@ ////////////////////////////////////////////////////////////////////////// #include "THaExtTarCor.h" +#include "hcana/Logger.h" class THaVertexModule; -class THcExtTarCor : public THaExtTarCor { +class THcExtTarCor : public hcana::ConfigLogging<THaExtTarCor> { public: THcExtTarCor( const char* name, const char* description, diff --git a/src/THcHallCSpectrometer.cxx b/src/THcHallCSpectrometer.cxx index 649bc4f37662f8d776da2a834454be8e76750165..f6002126192f460292564a42a475375693d56b65 100644 --- a/src/THcHallCSpectrometer.cxx +++ b/src/THcHallCSpectrometer.cxx @@ -108,7 +108,7 @@ using namespace std; //_____________________________________________________________________________ THcHallCSpectrometer::THcHallCSpectrometer( const char* name, const char* description ) : - THaSpectrometer( name, description ), fPresent(kTRUE) + hcana::ConfigLogging<THaSpectrometer>( name, description ), fPresent(kTRUE) { // Constructor. Defines the standard detectors for the HRS. // AddDetector( new THaTriggerTime("trg","Trigger-based time offset")); @@ -117,6 +117,11 @@ THcHallCSpectrometer::THcHallCSpectrometer( const char* name, const char* descri SetTrSorting(kTRUE); eventtypes.clear(); + + //_logger = spdlog::get("config"); + //if(!_logger) { + // _logger = spdlog::stdout_color_mt("config"); + //} } //_____________________________________________________________________________ @@ -200,7 +205,7 @@ Int_t THcHallCSpectrometer::ReadDatabase( const TDatime& date ) static const char* const here = "THcHallCSpectrometer::ReadDatabase"; #ifdef WITH_DEBUG - cout << "In THcHallCSpectrometer::ReadDatabase()" << endl; + //cout << "In THcHallCSpectrometer::ReadDatabase()" << endl; #endif const char* detector_name = "hod"; @@ -233,9 +238,7 @@ Int_t THcHallCSpectrometer::ReadDatabase( const TDatime& date ) char prefix[2]; -#ifdef WITH_DEBUG - cout << " GetName() " << GetName() << endl; -#endif + _spec_logger->info("Spectrometer {} ", GetName()); prefix[0]=tolower(GetName()[0]); prefix[1]='\0'; @@ -321,7 +324,7 @@ Int_t THcHallCSpectrometer::ReadDatabase( const TDatime& date ) fMispointing_y = 0.1*(-0.6); gHcParms->Define("pmispointing_y","SHMS Y-Mispointing", fMispointing_y); - cout << prefix[0] << " From Formula Mispointing_y = " << fMispointing_y << endl; + //cout << prefix[0] << " From Formula Mispointing_y = " << fMispointing_y << endl; } } @@ -340,7 +343,7 @@ Int_t THcHallCSpectrometer::ReadDatabase( const TDatime& date ) else {fMispointing_x = 0.1*(2.37-0.086*50+0.0012*50.*50.);} gHcParms->Define("hmispointing_x","HMS X-Mispointing", fMispointing_x); - cout << prefix[0] << " From Formula Mispointing_x = " << fMispointing_x << endl; + //cout << prefix[0] << " From Formula Mispointing_x = " << fMispointing_x << endl; } @@ -349,14 +352,14 @@ Int_t THcHallCSpectrometer::ReadDatabase( const TDatime& date ) fMispointing_x = 0.1*(-1.26); gHcParms->Define("pmispointing_x","SHMS X-Mispointing", fMispointing_x); - cout << prefix[0] << " From Formula Mispointing_x = " << fMispointing_x << endl; + //cout << prefix[0] << " From Formula Mispointing_x = " << fMispointing_x << endl; } } else { - cout << prefix[0] << " From Parameter Set Mispointing_x = " << fMispointing_x << endl; + //cout << prefix[0] << " From Parameter Set Mispointing_x = " << fMispointing_x << endl; } // @@ -364,26 +367,29 @@ Int_t THcHallCSpectrometer::ReadDatabase( const TDatime& date ) //EnforcePruneLimits(); #ifdef WITH_DEBUG - cout << "\n\n\nhodo planes = " << fNPlanes << endl; - cout << "sel using scin = " << fSelUsingScin << endl; - cout << "fPruneXp = " << fPruneXp << endl; - cout << "fPruneYp = " << fPruneYp << endl; - cout << "fPruneYtar = " << fPruneYtar << endl; - cout << "fPruneDelta = " << fPruneDelta << endl; - cout << "fPruneBeta = " << fPruneBeta << endl; - cout << "fPruneDf = " << fPruneDf << endl; - cout << "fPruneChiBeta = " << fPruneChiBeta << endl; - cout << "fPruneFpTime = " << fPruneFpTime << endl; - cout << "fPruneNPMT = " << fPruneNPMT << endl; - cout << "sel using prune = " << fSelUsingPrune << endl; + _logger->debug("Spectrometer {} ", GetName()); + _logger->debug("hodo planes = {}" , fNPlanes ); + _logger->debug("sel using scin = {}" , fSelUsingScin ); + _logger->debug("fPruneXp = {}" , fPruneXp ); + _logger->debug("fPruneYp = {}" , fPruneYp ); + _logger->debug("fPruneYtar = {}" , fPruneYtar ); + _logger->debug("fPruneDelta = {}" , fPruneDelta ); + _logger->debug("fPruneBeta = {}" , fPruneBeta ); + _logger->debug("fPruneDf = {}" , fPruneDf ); + _logger->debug("fPruneChiBeta = {}" , fPruneChiBeta ); + _logger->debug("fPruneFpTime = {}" , fPruneFpTime ); + _logger->debug("fPruneNPMT = {}" , fPruneNPMT ); + _logger->debug("sel using prune = {}" , fSelUsingPrune ); #endif - cout << "fPartMass = " << fPartMass << endl; - cout << "fPcentral = " << fPcentral << " " <<fPCentralOffset << endl; - cout << "fThetalab = " << fTheta_lab << " " <<fThetaCentralOffset << endl; - fPcentral= fPcentral*(1.+fPCentralOffset/100.); + _spec_logger->info("Spectrometer {} ", GetName()); + _spec_logger->info("fPartMass = {} ", fPartMass); + _spec_logger->info("fPcentral = {} {}", fPcentral, fPCentralOffset); + _spec_logger->info("fThetalab = {} {}", fTheta_lab, fThetaCentralOffset); + + fPcentral = fPcentral * (1. + fPCentralOffset / 100.); // Check that these offsets are in radians - fTheta_lab=fTheta_lab + fThetaCentralOffset*TMath::RadToDeg(); - Double_t ph = fPhi_lab+fPhiOffset*TMath::RadToDeg(); + fTheta_lab = fTheta_lab + fThetaCentralOffset * TMath::RadToDeg(); + Double_t ph = fPhi_lab + fPhiOffset * TMath::RadToDeg(); // SetCentralAngles method in podd THaSpectrometer // fTheta_lab and ph are geographical angles, converts to spherical coordinates // Need to set fTheta_lab to negative for spectrometer like HMS on beam right @@ -392,12 +398,12 @@ Int_t THcHallCSpectrometer::ReadDatabase( const TDatime& date ) Bool_t bend_down = kFALSE; SetCentralAngles(fTheta_lab, ph, bend_down); Double_t off_z = 0.0; - fPointingOffset.SetXYZ( fMispointing_x, fMispointing_y, off_z ); + fPointingOffset.SetXYZ(fMispointing_x, fMispointing_y, off_z); // ifstream ifile; ifile.open(reconCoeffFilename.c_str()); - if(!ifile.is_open()) { - Error(here, "error opening reconstruction coefficient file %s",reconCoeffFilename.c_str()); + if (!ifile.is_open()) { + Error(here, "error opening reconstruction coefficient file %s", reconCoeffFilename.c_str()); // return kInitError; // Is this the right return code? return kOK; } @@ -441,9 +447,9 @@ Int_t THcHallCSpectrometer::ReadDatabase( const TDatime& date ) fNReconTerms++; good = getline(ifile,line).good(); } - cout << "Read " << fNReconTerms << " matrix element terms" << endl; + _spec_logger->info("Read {} matrix element terms", fNReconTerms); if(!good) { - Error(here, "Error processing reconstruction coefficient file %s",reconCoeffFilename.c_str()); + _spec_logger->error("{} Error processing reconstruction coefficient file {}",here, reconCoeffFilename.c_str()); return kInitError; // Is this the right return code? } return kOK; diff --git a/src/THcHallCSpectrometer.h b/src/THcHallCSpectrometer.h index ee20876262411d030029b362c320081d424f5a38..a0a0061b71f36c1820aeeb319698802908b53b32 100644 --- a/src/THcHallCSpectrometer.h +++ b/src/THcHallCSpectrometer.h @@ -30,10 +30,17 @@ #include <iostream> #include <fstream> +//#include "spdlog/spdlog.h" +//#include "spdlog/sinks/stdout_color_sinks.h" //support for stdout logging +//#include "spdlog/sinks/basic_file_sink.h" // support for basic file logging + +#include "hcana/Logger.h" //class THaScintillator; -class THcHallCSpectrometer : public THaSpectrometer { +class THcHallCSpectrometer : public hcana::ConfigLogging<THaSpectrometer> { +private: + //std::shared_ptr<spdlog::logger> _logger; public: THcHallCSpectrometer( const char* name, const char* description ); diff --git a/src/THcHelicity.cxx b/src/THcHelicity.cxx index cb2d0d600120e8168b0e8acf428a810004fb1900..2fdc20bd1dcda5cf6d272d2ec21cdb3cf764e6af 100644 --- a/src/THcHelicity.cxx +++ b/src/THcHelicity.cxx @@ -6,40 +6,38 @@ // +1 = plus, -1 = minus, 0 = unknown // // Also supports in-time mode with delay = 0 -// +// //////////////////////////////////////////////////////////////////////// #include "THcHelicity.h" +#include "TH1F.h" #include "THaApparatus.h" #include "THaEvData.h" #include "THcGlobals.h" -#include "THcParmList.h" #include "THcHelicityScaler.h" -#include "TH1F.h" +#include "THcParmList.h" #include "TMath.h" -#include <iostream> #include <bitset> +#include <iostream> + +#include "THaHelicityDet.h" +#include "hcana/Logger.h" using namespace std; //_____________________________________________________________________________ -THcHelicity::THcHelicity( const char* name, const char* description, - THaApparatus* app ): - THaHelicityDet( name, description, app ), - fnQrt(-1), fHelDelay(8), fMAXBIT(30) -{ +THcHelicity::THcHelicity(const char* name, const char* description, THaApparatus* app) + : THaHelicityDet(name, description, app), fnQrt(-1), fHelDelay(8), fMAXBIT(30) { // for( Int_t i = 0; i < NHIST; ++i ) // fHisto[i] = 0; // memset(fHbits, 0, sizeof(fHbits)); fglHelicityScaler = 0; - fHelicityHistory = 0; + fHelicityHistory = 0; } //_____________________________________________________________________________ -THcHelicity::THcHelicity() - : fnQrt(-1), fHelDelay(8), fMAXBIT(30) -{ +THcHelicity::THcHelicity() : fnQrt(-1), fHelDelay(8), fMAXBIT(30) { // Default constructor for ROOT I/O // for( Int_t i = 0; i < NHIST; ++i ) @@ -47,9 +45,8 @@ THcHelicity::THcHelicity() } //_____________________________________________________________________________ -THcHelicity::~THcHelicity() -{ - DefineVariables( kDelete ); +THcHelicity::~THcHelicity() { + DefineVariables(kDelete); // for( Int_t i = 0; i < NHIST; ++i ) { // delete fHisto[i]; @@ -61,11 +58,11 @@ THaAnalysisObject::EStatus THcHelicity::Init(const TDatime& date) { // Call `Setup` before everything else. Setup(GetName(), GetTitle()); - fFirstEvProcessed = kFALSE; - fActualHelicity = kUnknown; + fFirstEvProcessed = kFALSE; + fActualHelicity = kUnknown; fPredictedHelicity = kUnknown; - fLastMPSTime = 0; - fFoundMPS = kFALSE; + fLastMPSTime = 0; + fFoundMPS = kFALSE; // Call initializer for base class. // This also calls `ReadDatabase` and `DefineVariables`. @@ -76,23 +73,26 @@ THaAnalysisObject::EStatus THcHelicity::Init(const TDatime& date) { } fEvNumCheck = 0; - fDisabled = kFALSE; + fDisabled = kFALSE; - fLastHelpCycle=-1; + fLastHelpCycle = -1; fQuadPattern[0] = fQuadPattern[1] = fQuadPattern[2] = fQuadPattern[3] = 0; fQuadPattern[4] = fQuadPattern[5] = fQuadPattern[6] = fQuadPattern[7] = 0; - fHelperHistory=0; - fHelperQuartetHistory=0; - fScalerSeed=0; - fNBits = 0; - lastispos = 0; - fLastReportedHelicity = kUnknown; - fFixFirstCycle = kFALSE; - fHaveQRT = kFALSE; - fNQRTProblems = 0; - fPeriodCheck = 0.0; - fPeriodCheckOffset = 0.0; - fCycle = 0.0; + fHelperHistory = 0; + fHelperQuartetHistory = 0; + fScalerSeed = 0; + fNBits = 0; + lastispos = 0; + fLastReportedHelicity = kUnknown; + fFixFirstCycle = kFALSE; + fHaveQRT = kFALSE; + fNQRTProblems = 0; + fPeriodCheck = 0.0; + fCycle = 0.0; + + fglHelicityScaler = 0; + fHelicityHistory = 0; + fRecommendedFreq = -1.0; fStatus = kOK; @@ -108,137 +108,125 @@ void THcHelicity::Setup(const char* name, const char* description) { } //_____________________________________________________________________________ -Int_t THcHelicity::ReadDatabase( const TDatime& date ) -{ +Int_t THcHelicity::ReadDatabase(const TDatime& date) { - cout << "In THcHelicity::ReadDatabase" << endl; + _logger->info("In THcHelicity::ReadDatabase"); // Read general HelicityDet database values (e.g. fSign) // Int_t st = THaHelicityDet::ReadDatabase( date ); // if( st != kOK ) // return st; // Read readout parameters (ROC addresses etc.) - Int_t st = THcHelicityReader::ReadDatabase( GetDBFileName(), GetPrefix(), - date, fQWEAKDebug ); - if( st != kOK ) - return st; + Int_t st = THcHelicityReader::ReadDatabase(GetDBFileName(), GetPrefix(), date, fQWEAKDebug); + if (st != kOK) + return st; - fSign = 1; // Default helicity sign + fSign = 1; // Default helicity sign fRingSeed_reported_initial = 0; // Initial see that should predict reported - // helicity of first quartet. - fFirstCycle = -1; // First Cycle that starts a quad (0 to 3) + // helicity of first quartet. + fFirstCycle = -1; // First Cycle that starts a quad (0 to 3) fNLastQuartet = -1; - fNQuartet = 0; + fNQuartet = 0; // fFreq = 29.5596; - fFreq = 120.0007547169; - fHelDelay=8; - - DBRequest list[]= { - // {"_hsign", &fSign, kInt, 0, 1}, - {"helicity_delay", &fHelDelay, kInt, 0, 1}, - {"helicity_freq", &fFreq, kDouble, 0, 1}, - // {"helicity_seed", &fRingSeed_reported_initial, kInt, 0, 1}, - // {"helicity_cycle", &fFirstCycle, kInt, 0, 1}, - {0} - }; + fFreq = 120.0007547169; + fHelDelay = 8; + + DBRequest list[] = {// {"_hsign", &fSign, kInt, 0, 1}, + {"helicity_delay", &fHelDelay, kInt, 0, 1}, + {"helicity_freq", &fFreq, kDouble, 0, 1}, + // {"helicity_seed", &fRingSeed_reported_initial, kInt, 0, 1}, + // {"helicity_cycle", &fFirstCycle, kInt, 0, 1}, + {0}}; gHcParms->LoadParmValues(list, ""); - fMAXBIT=30; + fMAXBIT = 30; - fTIPeriod = 250000000.0/fFreq; + fTIPeriod = 250000000.0 / fFreq; // maximum of event in the pattern, for now we are working with quartets - // Int_t localpattern[4]={1,-1,-1,1}; + // Int_t localpattern[4]={1,-1,-1,1}; // careful, the first value here should always +1 // for(int i=0;i<fQWEAKNPattern;i++) // { // fPatternSequence.push_back(localpattern[i]); // } - HWPIN=kTRUE; + HWPIN = kTRUE; - fQuartet[0]=fQuartet[1]=fQuartet[2]=fQuartet[3]=0; + fQuartet[0] = fQuartet[1] = fQuartet[2] = fQuartet[3] = 0; - if (fFirstCycle>=0 && fRingSeed_reported_initial!=0) { + if (fFirstCycle >= 0 && fRingSeed_reported_initial != 0) { // Set the seed for predicted reported and predicted actual } else { // Initialize mode to find quartets and then seed } - cout << "Helicity decoder initialized with frequency of " << fFreq - << " Hz and reporting delay of " << fHelDelay << " cycles." << endl; + _logger->info( + "Helicity decoder initialized with frequency of {} Hz and reporting delay of {} cycles.", + fFreq, fHelDelay); return kOK; } //_____________________________________________________________________________ -void THcHelicity::MakePrefix() -{ - THaDetector::MakePrefix(); -} +void THcHelicity::MakePrefix() { THaDetector::MakePrefix(); } //_____________________________________________________________________________ -Int_t THcHelicity::DefineVariables( EMode mode ) -{ +Int_t THcHelicity::DefineVariables(EMode mode) { // Initialize global variables - cout << "Called THcHelicity::DefineVariables with mode == " - << mode << endl; + _logger->info("Called THcHelicity::DefineVariables with mode == {}", mode); - if( mode == kDefine && fIsSetup ) return kOK; - fIsSetup = ( mode == kDefine ); + if (mode == kDefine && fIsSetup) + return kOK; + fIsSetup = (mode == kDefine); // Define standard variables from base class - THaHelicityDet::DefineVariables( mode ); - - const RVarDef var[] = { - { "nqrt", "position of cycle in quartet", "fnQrt" }, - { "hel", "actual helicity for event", "fActualHelicity" }, - { "helrep", "reported helicity for event", "fReportedHelicity" }, - { "helpred", "predicted reported helicity for event", "fPredictedHelicity" }, - { "mps", "In MPS blanking period", "fMPS"}, - { "pcheck", "Period check", "fPeriodCheck"}, - { "cycle", "Helicity Cycle", "fCycle"}, - { "qrt", "Last cycle of quartet", "fQrt"}, - { 0 } - }; - cout << "Calling THcHelicity DefineVarsFromList" << endl; - return DefineVarsFromList( var, mode ); + THaHelicityDet::DefineVariables(mode); + + const RVarDef var[] = {{"nqrt", "position of cycle in quartet", "fnQrt"}, + {"hel", "actual helicity for event", "fActualHelicity"}, + {"helrep", "reported helicity for event", "fReportedHelicity"}, + {"helpred", "predicted reported helicity for event", "fPredictedHelicity"}, + {"mps", "In MPS blanking period", "fMPS"}, + {"pcheck", "Period check", "fPeriodCheck"}, + {"cycle", "Helicity Cycle", "fCycle"}, + {"qrt", "Last cycle of quartet", "fQrt"}, + {0}}; + _logger->info("Calling THcHelicity DefineVarsFromList"); + return DefineVarsFromList(var, mode); } //_____________________________________________________________________________ -void THcHelicity::PrintEvent(Int_t evtnum) -{ +void THcHelicity::PrintEvent(Int_t evtnum) { - cout<<" ++++++ THcHelicity::Print ++++++\n"; + _logger->info(" ++++++ THcHelicity::Print ++++++"); - cout<<" +++++++++++++++++++++++++++++++++++++\n"; + _logger->info(" +++++++++++++++++++++++++++++++++++++\n"); return; } //_____________________________________________________________________________ -Int_t THcHelicity::Begin( THaRunBase* ) -{ +Int_t THcHelicity::Begin(THaRunBase*) { THcHelicityReader::Begin(); // fHisto[0] = new TH1F("hel.seed","hel.seed",32,-1.5,30.5); // fHisto[1] = new TH1F("hel.error.code","hel.error.code",35,-1.5,33.5); - + return 0; } //_____________________________________________________________________________ -//void THcHelicity::FillHisto() +// void THcHelicity::FillHisto() //{ // fHisto[0]->Fill(fRing_NSeed); // fHisto[1]->Fill(fErrorCode); // return; //} //_____________________________________________________________________________ -void THcHelicity::SetErrorCode(Int_t error) -{ - // used as a control for the helciity computation +void THcHelicity::SetErrorCode(Int_t error) { + // used as a control for the helciity computation // 2^0: if the reported number of events in a pattern is larger than fQWEAKNPattern // 2^1: if the offset between the ring reported value and TIR value is not fOffsetTIRvsRing // 2^2: if the reported time in the ring is 0 @@ -246,359 +234,323 @@ void THcHelicity::SetErrorCode(Int_t error) // 2^4: if the helicity cannot be computed using the SetHelicity routine // 2^5: if seed is being gathered - if(fErrorCode==0) - fErrorCode=(1<<error); + if (fErrorCode == 0) + fErrorCode = (1 << error); // only one reported error at the time return; } //_____________________________________________________________________________ -void THcHelicity::Clear( Option_t* opt ) -{ +void THcHelicity::Clear(Option_t* opt) { // Clear event-by-event data THaHelicityDet::Clear(opt); THcHelicityReader::Clear(opt); fEvtype = 0; - fQrt=0; - fErrorCode=0; + fQrt = 0; + fErrorCode = 0; return; } //_____________________________________________________________________________ -void THcHelicity::SetHelicityScaler( THcHelicityScaler *f ) -{ - fglHelicityScaler = f; - fHelicityHistory = fglHelicityScaler->GetHelicityHistoryP(); +void THcHelicity::SetHelicityScaler(THcHelicityScaler* f) { + fglHelicityScaler = f; + fHelicityHistory = fglHelicityScaler->GetHelicityHistoryP(); } //_____________________________________________________________________________ -Int_t THcHelicity::Decode( const THaEvData& evdata ) -{ +Int_t THcHelicity::Decode(const THaEvData& evdata) { // Decode Helicity data. // Return 1 if helicity was assigned, 0 if not, <0 if error. evnum = evdata.GetEvNum(); - Int_t err = ReadData( evdata ); // from THcHelicityReader class - if( err ) { - Error( Here("THcHelicity::Decode"), "Error decoding helicity data." ); + Int_t err = ReadData(evdata); // from THcHelicityReader class + if (err) { + _logger->error("THcHelicity::Decode : Error decoding helicity data."); return err; } - fReportedHelicity = (fIsHelp?(fIsHelm?kUnknown:kPlus):(fIsHelm?kMinus:kUnknown)); - fMPS = fIsMPS?1:0; - fQrt = fIsQrt?1:0; // Last of quartet - -#if 0 - if(fglHelicityScaler) { - Int_t nhelev = fglHelicityScaler->GetNevents(); - Int_t ncycles = fglHelicityScaler->GetNcycles(); - if(nhelev >0) { - for(Int_t i=0;i<nhelev;i++) { - fScaleQuartet = (fHelicityHistory[i] & 2)!=0; - Int_t ispos = fHelicityHistory[i]&1; - if(fScaleQuartet) { - fScalerSeed = ((fScalerSeed<<1) | ispos) & 0x3FFFFFFF; - if(fNBits >= fMAXBIT+0) { - Int_t seedscan = fScalerSeed; - Int_t nbehind; - for(nbehind=0;nbehind<4;nbehind++) { - if(seedscan == fRingSeed_reported) { - if(nbehind>1) { - cout << "Scaler seed behind " << nbehind - << " quartets" << endl; - cout << "Ev seed " << bitset<32>(fRingSeed_reported) <<endl; - cout << "Scaler Seed " << bitset<32>(fScalerSeed) << endl; - } - break; - } - seedscan = RanBit30(seedscan); - } - if(nbehind>4) { - cout << "Scaler seed does not match" << endl; - cout << "Ev seed " << bitset<32>(fRingSeed_reported) <<endl; - cout << "Scaler Seed " << bitset<32>(fScalerSeed) << endl; - } - } - } - } - } - } -#endif - - if(fHelDelay == 0) { // If no delay actual=reported (but zero if in MPS) - fActualHelicity = fIsMPS?kUnknown:fReportedHelicity; + fReportedHelicity = (fIsHelp ? (fIsHelm ? kUnknown : kPlus) : (fIsHelm ? kMinus : kUnknown)); + fMPS = fIsMPS ? 1 : 0; + fQrt = fIsQrt ? 1 : 0; // Last of quartet + + if (fHelDelay == 0) { // If no delay actual=reported (but zero if in MPS) + fActualHelicity = fIsMPS ? kUnknown : fReportedHelicity; return 0; } - if(fDisabled) { + if (fDisabled) { fActualHelicity = kUnknown; return 0; } fEvNumCheck++; Int_t evnum = evdata.GetEvNum(); - if(fEvNumCheck!=evnum) { - cout << "THcHelicity: Missed " << evnum-fEvNumCheck << " events at event " << evnum << endl; - cout << " Disabling helicity decoding for rest of run." << endl; - cout << " Make sure \"RawDecode_master in cuts file accepts all physics events." <<endl; - fDisabled = kTRUE; + if (fEvNumCheck != evnum) { + _logger->info("THcHelicity: Missed {} events at event {}.", evnum - fEvNumCheck, evnum); + _logger->info(" Disabling helicity decoding for rest of run."); + _logger->info( + " Make sure \"RawDecode_master in cuts file accepts all physics events."); + fDisabled = kTRUE; fActualHelicity = kUnknown; return 0; } fActualHelicity = -10.0; - if(fFirstEvProcessed) { // Normal processing - // cout << evnum << " " << fNCycle << " " << fIsMPS << " " << fFoundMPS << " " << fTITime << " " + if (fFirstEvProcessed) { // Normal processing + // cout << evnum << " " << fNCycle << " " << fIsMPS << " " << fFoundMPS << " " << fTITime << + // " " // << fLastMPSTime << " " << fNBits << endl; Int_t missed = 0; // Double_t elapsed_time = (fTITime - fFirstEvTime)/250000000.0; - if(fIsMPS) { - fPeriodCheck = fmod(fTITime/(250000000.0/fFreq)-fPeriodCheckOffset,1.0); + if (fIsMPS) { + fPeriodCheck = fmod(fTITime / (250000000.0 / fFreq) - fPeriodCheckOffset, 1.0); - fCycle = (fTITime/fTIPeriod); - fActualHelicity = kUnknown; + fCycle = (fTITime / fTIPeriod); + fActualHelicity = kUnknown; fPredictedHelicity = kUnknown; - if(fFoundMPS) { - if(fRecommendedFreq < 0.0) { - if(TMath::Abs(fPeriodCheck-0.5) > 0.25) { - fRecommendedFreq = fFreq*(1-(fPeriodCheck-0.5)/fCycle); - } - } - missed = TMath::Nint(fTITime/fTIPeriod-fLastMPSTime/fTIPeriod); - if(missed < 1) { // was <=1 - fLastMPSTime = (fTITime+fLastMPSTime+missed*fTIPeriod)/2; - fIsNewCycle = kTRUE; - fActualHelicity = kUnknown; - fPredictedHelicity = kUnknown; - } else { - fLastMPSTime = (fLastMPSTime + fTITime - missed*fTIPeriod)/2; - } - // If there is a skip, pass it off to next non MPS event - // Need to also check here for missed MPS's - // cout << "Found MPS" << endl; - // check for Nint((time-last)/period) > 1 + if (fFoundMPS) { + if (fRecommendedFreq < 0.0) { + if (TMath::Abs(fPeriodCheck - 0.5) > 0.25) { + fRecommendedFreq = fFreq * (1 - (fPeriodCheck - 0.5) / fCycle); + } + } + missed = TMath::Nint(fTITime / fTIPeriod - fLastMPSTime / fTIPeriod); + if (missed < 1) { // was <=1 + fLastMPSTime = (fTITime + fLastMPSTime + missed * fTIPeriod) / 2; + fIsNewCycle = kTRUE; + fActualHelicity = kUnknown; + fPredictedHelicity = kUnknown; + } else { + fLastMPSTime = (fLastMPSTime + fTITime - missed * fTIPeriod) / 2; + } + // If there is a skip, pass it off to next non MPS event + // Need to also check here for missed MPS's + // cout << "Found MPS" << endl; + // check for Nint((time-last)/period) > 1 } else { - fFoundMPS = kTRUE; - fLastMPSTime = fTITime; - fPeriodCheckOffset = (fPeriodCheck-.5); + fFoundMPS = kTRUE; + fLastMPSTime = fTITime; + fPeriodCheckOffset = (fPeriodCheck - .5); } - } else if (fFoundMPS) { // - if(fTITime - fLastMPSTime > fTIPeriod) { // We missed MPS periods - missed = TMath::Nint(floor((fTITime-fLastMPSTime)/fTIPeriod)); - if(missed > 1) { - // cout << "Missed " << missed << " MPSes" << endl; - Int_t newNCycle = fNCycle + missed -1; // How many cycles really missed - Int_t quartets_missed = (newNCycle-fFirstCycle)/4 - (fNCycle-fFirstCycle)/4; - int quartetphase = (newNCycle-fFirstCycle)%4; - // cout << " " << fNCycle << " " << newNCycle << " " << fFirstCycle << " " << quartets_missed << " " << quartetphase << endl; - // cout << "Cycles " << fNCycle << " " << newNCycle << " " << fFirstCycle - // << " skipped " << quartets_missed << " quartets" << endl; - fNCycle = newNCycle; - // Need to reset fQuartet to reflect where we are based on the current - // reported helicity. So we don't fail quartet testing. - // But only do this if we are calibrated. - if(fNBits >= fMAXBIT+0) { - - for(Int_t i=0;i<quartets_missed;i++) { // Advance the seeds. - // cout << "Advancing seed A " << fNBits << endl; - fRingSeed_reported = RanBit30(fRingSeed_reported); - fRingSeed_actual = RanBit30(fRingSeed_actual); - } - - fQuartetStartHelicity = (fRingSeed_actual&1)?kPlus:kMinus; - fQuartetStartPredictedHelicity = (fRingSeed_reported&1)?kPlus:kMinus; - fActualHelicity = (quartetphase==0||quartetphase==3)? - fQuartetStartHelicity:-fQuartetStartHelicity; - fPredictedHelicity = (quartetphase==0||quartetphase==3)? - fQuartetStartPredictedHelicity:-fQuartetStartPredictedHelicity; - - if (((fNCycle - fFirstCycle)%2)==1) { - fQuartet[0] = fReportedHelicity; - fQuartet[1] = fQuartet[2] = -fQuartet[0]; - } else { - fQuartet[0] = fQuartet[1] = -fReportedHelicity; - fQuartet[2] = -fQuartet[1]; - } - } else { - fActualHelicity = kUnknown; - fQuartet[0] = fReportedHelicity; - fQuartet[1] = 0; - } - } - fLastMPSTime += missed*fTIPeriod; - fIsNewCycle = kTRUE; - fLastReportedHelicity = fReportedHelicity; - } else { // No missed periods. Get helicities from rings - if(fNBits>=fMAXBIT+0) { - int quartetphase = (fNCycle-fFirstCycle)%4; - fQuartetStartHelicity = (fRingSeed_actual&1)?kPlus:kMinus; - fQuartetStartPredictedHelicity = (fRingSeed_reported&1)?kPlus:kMinus; - fActualHelicity = (quartetphase==0||quartetphase==3)? - fQuartetStartHelicity:-fQuartetStartHelicity; - fPredictedHelicity = (quartetphase==0||quartetphase==3)? - fQuartetStartPredictedHelicity:-fQuartetStartPredictedHelicity; - } else { - fActualHelicity = 0; - } + } else if (fFoundMPS) { // + if (fTITime - fLastMPSTime > fTIPeriod) { // We missed MPS periods + missed = TMath::Nint(floor((fTITime - fLastMPSTime) / fTIPeriod)); + if (missed > 1) { + // cout << "Missed " << missed << " MPSes" << endl; + Int_t newNCycle = fNCycle + missed - 1; // How many cycles really missed + Int_t quartets_missed = (newNCycle - fFirstCycle) / 4 - (fNCycle - fFirstCycle) / 4; + int quartetphase = (newNCycle - fFirstCycle) % 4; + // cout << " " << fNCycle << " " << newNCycle << " " << fFirstCycle << " " << + // quartets_missed << " " << quartetphase << endl; + // cout << "Cycles " << fNCycle << " " << newNCycle << " " << fFirstCycle + // << " skipped " << quartets_missed << " quartets" << endl; + fNCycle = newNCycle; + // Need to reset fQuartet to reflect where we are based on the current + // reported helicity. So we don't fail quartet testing. + // But only do this if we are calibrated. + if (fNBits >= fMAXBIT + 0) { + + for (Int_t i = 0; i < quartets_missed; i++) { // Advance the seeds. + // cout << "Advancing seed A " << fNBits << endl; + fRingSeed_reported = RanBit30(fRingSeed_reported); + fRingSeed_actual = RanBit30(fRingSeed_actual); + } + + fQuartetStartHelicity = (fRingSeed_actual & 1) ? kPlus : kMinus; + fQuartetStartPredictedHelicity = (fRingSeed_reported & 1) ? kPlus : kMinus; + fActualHelicity = (quartetphase == 0 || quartetphase == 3) ? fQuartetStartHelicity + : -fQuartetStartHelicity; + fPredictedHelicity = (quartetphase == 0 || quartetphase == 3) + ? fQuartetStartPredictedHelicity + : -fQuartetStartPredictedHelicity; + + if (((fNCycle - fFirstCycle) % 2) == 1) { + fQuartet[0] = fReportedHelicity; + fQuartet[1] = fQuartet[2] = -fQuartet[0]; + } else { + fQuartet[0] = fQuartet[1] = -fReportedHelicity; + fQuartet[2] = -fQuartet[1]; + } + } else { + fActualHelicity = kUnknown; + fQuartet[0] = fReportedHelicity; + fQuartet[1] = 0; + } + } + fLastMPSTime += missed * fTIPeriod; + fIsNewCycle = kTRUE; + fLastReportedHelicity = fReportedHelicity; + } else { // No missed periods. Get helicities from rings + if (fNBits >= fMAXBIT + 0) { + int quartetphase = (fNCycle - fFirstCycle) % 4; + fQuartetStartHelicity = (fRingSeed_actual & 1) ? kPlus : kMinus; + fQuartetStartPredictedHelicity = (fRingSeed_reported & 1) ? kPlus : kMinus; + fActualHelicity = (quartetphase == 0 || quartetphase == 3) ? fQuartetStartHelicity + : -fQuartetStartHelicity; + fPredictedHelicity = (quartetphase == 0 || quartetphase == 3) + ? fQuartetStartPredictedHelicity + : -fQuartetStartPredictedHelicity; + } else { + fActualHelicity = 0; + } } - if(fIsNewCycle) { - // cout << "Scaler Seed " << bitset<32>(fScalerSeed) << endl; - //Int_t predictedScalerSeed = RanBit30(fScalerSeed); - // cout << "Predct Seed " << bitset<32>(predictedScalerSeed) << endl; - //cout << "Event Seed " << bitset<32>(fRingSeed_reported) << endl; - - fQuartet[3]=fQuartet[2]; fQuartet[2]=fQuartet[1]; fQuartet[1]=fQuartet[0]; - fQuartet[0]=fReportedHelicity; - fNCycle++; - // cout << "XX: " << fNCycle << " " << fReportedHelicity << " " << fIsQrt <<endl; - - if(fIsQrt) { // - fNLastQuartet = fNQuartet; - fNQuartet = (fNCycle-fFirstCycle)/4; - if(fHaveQRT) { // Should already have phase set - if((fNCycle-fFirstCycle)%4 != 0) {// Test if first in a quartet - fNQRTProblems++; - if(fNQRTProblems > 10) { - cout << "QRT Problem resetting" << endl; - fHaveQRT = kFALSE; - fFoundQuartet = kFALSE; - fNQRTProblems = 0; - } else { - cout << "Ignored " << fNQRTProblems << " problems" << endl; - } - } else { - fNQRTProblems = 0; - } - } - if(!fHaveQRT) { - fHaveQRT = kTRUE; - fFoundQuartet = kTRUE; - - fFirstCycle = fNCycle; // - fNQuartet = (fNCycle-fFirstCycle)/4; - fNLastQuartet = fNQuartet - 1; // Make sure LoadHelicity uses - fNBits = 0; - fNQRTProblems = 0; - cout << "Phase found from QRT signal" << endl; - cout << "fFirstcycle = " << fFirstCycle << endl; - } - } else { - if(fHaveQRT) { // Using qrt signal. - fNLastQuartet = fNQuartet; - fNQuartet = (fNCycle-fFirstCycle)/4; - if((fNCycle-fFirstCycle)%4 == 0) { // Shouldn't happen - fNQRTProblems++; - if(fNQRTProblems > 10) { - cout << "Shouldn't happen, cycle=" << fNCycle << "/" << fFirstCycle << endl; - fHaveQRT = kFALSE; // False until a new QRT seen - fNBits = 0; // Reset - fNLastQuartet = fNQuartet; // Make sure LoadHelicity does not use - } else { - cout << "Ignored " << fNQRTProblems << " problems" << endl; - } - } - } else { // Presumable pre qrt signal data - if((fNCycle-fFirstCycle)%4 == 3) {// Test if last in a quartet - if((abs(fQuartet[0]+fQuartet[3]-fQuartet[1]-fQuartet[2])==4)) { - if(!fFoundQuartet) { - // fFirstCycle = fNCycle - 3; - cout << "Quartet potentially found, starting at cycle " << fFirstCycle - << endl; - fNQuartet = (fNCycle-fFirstCycle)/4; - fNLastQuartet = fNQuartet - 1; // Make sure LoadHelicity uses - fFoundQuartet = kTRUE; - } - } else { - if(fNCycle - fFirstCycle > 4) { // Not at start of run. Reset - cout << "Lost quartet sync at cycle " << fNCycle << endl; - cout << fQuartet[0] << " " << fQuartet[1] << " " << fQuartet[2] << " " - << fQuartet[3] << endl; - fFirstCycle += 4*((fNCycle-fFirstCycle)/4); // Update, but don't change phase - } - fFoundQuartet = kFALSE; - fNBits = 0; - cout << "Searching for first of a quartet at cycle " << " " << fFirstCycle - << endl; - cout << fQuartet[0] << " " << fQuartet[1] << " " << fQuartet[2] << " " - << fQuartet[3] << endl; - fFirstCycle++; - } - } else { - fNLastQuartet = fNQuartet; - fNQuartet = (fNCycle-fFirstCycle)/4; - } - } - } - // Load the actual helicity. Calibrate if not calibrated. - fActualHelicity = kUnknown; - // Here if we know we missed some earlier in the quartet, we need - // to make sure we get here and call LoadHelicity for the missing - // Cycles, reducing the missed count for each extra loadhelicity - // call that we make. - LoadHelicity(fReportedHelicity, fNCycle, missed); - fLastReportedHelicity = fReportedHelicity; - fIsNewCycle = kFALSE; - // cout << fTITime/250000000.0 << " " << fNCycle << " " << fReportedHelicity << endl; - // cout << fNCycle << ": " << fReportedHelicity << " " - // << fPredictedHelicity << " " << fActualHelicity << endl; + if (fIsNewCycle) { + // cout << "Scaler Seed " << bitset<32>(fScalerSeed) << endl; + // Int_t predictedScalerSeed = RanBit30(fScalerSeed); + // cout << "Predct Seed " << bitset<32>(predictedScalerSeed) << endl; + // cout << "Event Seed " << bitset<32>(fRingSeed_reported) << endl; + + fQuartet[3] = fQuartet[2]; + fQuartet[2] = fQuartet[1]; + fQuartet[1] = fQuartet[0]; + fQuartet[0] = fReportedHelicity; + fNCycle++; + // cout << "XX: " << fNCycle << " " << fReportedHelicity << " " << fIsQrt <<endl; + + if (fIsQrt) { // + fNLastQuartet = fNQuartet; + fNQuartet = (fNCycle - fFirstCycle) / 4; + if (fHaveQRT) { // Should already have phase set + if ((fNCycle - fFirstCycle) % 4 != 0) { // Test if first in a quartet + fNQRTProblems++; + if (fNQRTProblems > 10) { + _logger->warn("QRT Problem resetting"); + fHaveQRT = kFALSE; + fFoundQuartet = kFALSE; + fNQRTProblems = 0; + } else { + _logger->warn("Ignored {} problems", fNQRTProblems); + } + } else { + fNQRTProblems = 0; + } + } + if (!fHaveQRT) { + fHaveQRT = kTRUE; + fFoundQuartet = kTRUE; + + fFirstCycle = fNCycle; // + fNQuartet = (fNCycle - fFirstCycle) / 4; + fNLastQuartet = fNQuartet - 1; // Make sure LoadHelicity uses + fNBits = 0; + fNQRTProblems = 0; + _logger->info("Phase found from QRT signal"); + _logger->info("fFirstCycle = {}", fFirstCycle); + } + } else { + if (fHaveQRT) { // Using qrt signal. + fNLastQuartet = fNQuartet; + fNQuartet = (fNCycle - fFirstCycle) / 4; + if ((fNCycle - fFirstCycle) % 4 == 0) { // Shouldn't happen + fNQRTProblems++; + if (fNQRTProblems > 10) { + _logger->warn("Shouldn't happen, cycle= {} / {}", fNCycle, fFirstCycle); + fHaveQRT = kFALSE; // False until a new QRT seen + fNBits = 0; // Reset + fNLastQuartet = fNQuartet; // Make sure LoadHelicity does not use + } else { + _logger->warn("Ignored {} problems", fNQRTProblems); + } + } + } else { // Presumable pre qrt signal data + if ((fNCycle - fFirstCycle) % 4 == 3) { // Test if last in a quartet + if ((abs(fQuartet[0] + fQuartet[3] - fQuartet[1] - fQuartet[2]) == 4)) { + if (!fFoundQuartet) { + // fFirstCycle = fNCycle - 3; + _logger->warn("Quartet potentially found, starting at cycle {}", fFirstCycle); + fNQuartet = (fNCycle - fFirstCycle) / 4; + fNLastQuartet = fNQuartet - 1; // Make sure LoadHelicity uses + fFoundQuartet = kTRUE; + } + } else { + if (fNCycle - fFirstCycle > 4) { // Not at start of run. Reset + _logger->warn("Lost quartet sync at cycle {}: {} {} {} {}", fNCycle, fQuartet[0], + fQuartet[1], fQuartet[2], fQuartet[3]); + fFirstCycle += + 4 * ((fNCycle - fFirstCycle) / 4); // Update, but don't change phase + } + fFoundQuartet = kFALSE; + fNBits = 0; + _logger->info("Searching for first of a quartet at cycle {}: {} {} {} {}", + fFirstCycle, fQuartet[0], fQuartet[1], fQuartet[2], fQuartet[3]); + fFirstCycle++; + } + } else { + fNLastQuartet = fNQuartet; + fNQuartet = (fNCycle - fFirstCycle) / 4; + } + } + } + // Load the actual helicity. Calibrate if not calibrated. + fActualHelicity = kUnknown; + // Here if we know we missed some earlier in the quartet, we need + // to make sure we get here and call LoadHelicity for the missing + // Cycles, reducing the missed count for each extra loadhelicity + // call that we make. + LoadHelicity(fReportedHelicity, fNCycle, missed); + fLastReportedHelicity = fReportedHelicity; + fIsNewCycle = kFALSE; + // cout << fTITime/250000000.0 << " " << fNCycle << " " << fReportedHelicity << endl; + // cout << fNCycle << ": " << fReportedHelicity << " " + // << fPredictedHelicity << " " << fActualHelicity << endl; } // Ignore until a MPS Is found - } else { // No MPS found yet + } else { // No MPS found yet fActualHelicity = kUnknown; } } else { - cout << "Initializing" << endl; + _logger->info("Initializing Helicity"); fLastReportedHelicity = fReportedHelicity; - fActualHelicity = kUnknown; - fPredictedHelicity = kUnknown; - fFirstEvTime = fTITime; - fLastEvTime = fTITime; - fLastMPSTime = fTITime; // Not necessarily during the MPS - fNCycle = 0; - fFirstEvProcessed = kTRUE; - fFoundMPS = kFALSE; - fFoundQuartet = kFALSE; - fIsNewCycle = kFALSE; - fNBits = 0; + fActualHelicity = kUnknown; + fPredictedHelicity = kUnknown; + fFirstEvTime = fTITime; + fLastEvTime = fTITime; + fLastMPSTime = fTITime; // Not necessarily during the MPS + fNCycle = 0; + fFirstEvProcessed = kTRUE; + fFoundMPS = kFALSE; + fFoundQuartet = kFALSE; + fIsNewCycle = kFALSE; + fNBits = 0; } // Some sanity checks - if(fActualHelicity < -5) { - cout << "Actual Helicity never got defined" << endl; + if (fActualHelicity < -5) { + _logger->warn("Actual Helicity never got defined"); } - if(fNBits < fMAXBIT+0) { - if(fActualHelicity == -1 || fActualHelicity == 1) { - cout << "Helicity of " << fActualHelicity << " reported prematurely at cycle " << fNCycle << endl; + if (fNBits < fMAXBIT) { + if (fActualHelicity == -1 || fActualHelicity == 1) { + _logger->warn("Helicity of {} reported prematurely at cycle {}", fActualHelicity, fNCycle); } } fLastActualHelicity = fActualHelicity; return 0; } //_____________________________________________________________________________ -Int_t THcHelicity::End( THaRunBase* ) -{ +Int_t THcHelicity::End(THaRunBase*) { // End of run processing. Write histograms. THcHelicityReader::End(); // for( Int_t i = 0; i < NHIST; ++i ) // fHisto[i]->Write(); - if(fRecommendedFreq < 0.0) { - fRecommendedFreq = fFreq*(1-(fPeriodCheck-0.5)/fCycle); + if (fRecommendedFreq < 0.0) { + fRecommendedFreq = fFreq * (1 - (fPeriodCheck - 0.5) / fCycle); } - if(TMath::Abs(1-fRecommendedFreq/fFreq) >= 0.5e-6) { + if (TMath::Abs(1 - fRecommendedFreq / fFreq) >= 0.5e-6) { cout << "------------- HELICITY DECODING ----------------------" << endl; cout << "Actual helicity reversal frequency differs from \"helicity_freq\" value" << endl; cout << "If there are helicity decoding errors beyond the start of the run, " << endl; streamsize ss = cout.precision(); cout.precision(10); - cout << "try replacing helicity_freq value of " << fFreq << " with " << fRecommendedFreq << endl; - cout << "If that still gives helicity errors, try " << 0.9999999*fRecommendedFreq << endl; + cout << "try replacing helicity_freq value of " << fFreq << " with " << fRecommendedFreq + << endl; + cout << "If that still gives helicity errors, try " << 0.9999999 * fRecommendedFreq << endl; cout.precision(ss); cout << "------------------------------------------------------" << endl; } @@ -607,187 +559,187 @@ Int_t THcHelicity::End( THaRunBase* ) } //_____________________________________________________________________________ -void THcHelicity::SetDebug( Int_t level ) -{ - // Set debug level of this detector as well as the THcHelicityReader +void THcHelicity::SetDebug(Int_t level) { + // Set debug level of this detector as well as the THcHelicityReader // helper class. - THaHelicityDet::SetDebug( level ); + THaHelicityDet::SetDebug(level); fQWEAKDebug = level; } //_____________________________________________________________________________ -void THcHelicity::LoadHelicity(Int_t reportedhelicity, Int_t cyclecount, Int_t missedcycles) -{ +void THcHelicity::LoadHelicity(Int_t reportedhelicity, Int_t cyclecount, Int_t missedcycles) { + // static const char* const here = "THcHelicity::LoadHelicity"; - int quartetphase = (cyclecount-fFirstCycle)%4; - fnQrt = quartetphase; + int quartetphase = (cyclecount - fFirstCycle) % 4; + fnQrt = quartetphase; // if(!fFixFirstCycle) { - if(fNQuartet - fNLastQuartet > 1) { // If we missed a quartet - if(fNBits< fMAXBIT+0) { // and we haven't gotten the seed, start over - cout << "fNBits = 0, missedcycles=" << missedcycles << - " " << fNLastQuartet << " " << fNQuartet << endl; - fNBits = 0; - return; - } + if (fNQuartet - fNLastQuartet > 1) { // If we missed a quartet + if (fNBits < fMAXBIT) { // and we haven't gotten the seed, start over + _logger->warn("fNBits = 0, missedcycles={} {} {}", missedcycles, fNLastQuartet, + fNQuartet); + fNBits = 0; + return; } - // } - if(!fFoundQuartet) { // Wait until we have found quad phase before starting - return; // to calibrate + } + // } + if (!fFoundQuartet) { // Wait until we have found quad phase before starting + return; // to calibrate } // LoadHelicity is called first event of each cycle. // But only do it's thing if it is first cycle of quartet. // Need to instead have it do it's thing on the first event of a quartet. // But only for seed building. Current logic is OK once seed is found. - if(fNBits < fMAXBIT+0) { - if(fNQuartet != fNLastQuartet) { + if (fNBits < fMAXBIT) { + if (fNQuartet != fNLastQuartet) { // Sanity check fNQuartet == fNLastQuartet+1 - if(fNBits == 0) { - cout << "Start calibrating at cycle " << cyclecount << endl; - fRingSeed_reported = 0; + if (fNBits == 0) { + _logger->info("Start calibrating at cycle {}", cyclecount); + fRingSeed_reported = 0; } // Do phase stuff right here - if((fReportedHelicity == kPlus && (quartetphase==0 || quartetphase == 3)) - || (fReportedHelicity == kMinus && (quartetphase==1 || quartetphase == 2))) { - fRingSeed_reported = ((fRingSeed_reported<<1) | 1) & 0x3FFFFFFF; - // cout << " " << fNQuartet << " 1" << endl; + if ((fReportedHelicity == kPlus && (quartetphase == 0 || quartetphase == 3)) || + (fReportedHelicity == kMinus && (quartetphase == 1 || quartetphase == 2))) { + fRingSeed_reported = ((fRingSeed_reported << 1) | 1) & 0x3FFFFFFF; + // cout << " " << fNQuartet << " 1" << endl; } else { - fRingSeed_reported = (fRingSeed_reported<<1) & 0x3FFFFFFF; - // cout << " " << fNQuartet << " 0" << endl; + fRingSeed_reported = (fRingSeed_reported << 1) & 0x3FFFFFFF; + // cout << " " << fNQuartet << " 0" << endl; } fNBits++; - if(fReportedHelicity == kUnknown) { - fNBits = 0; - fRingSeed_reported = 0; - } else if (fNBits==fMAXBIT+0) { - cout << " Seed Found " << bitset<32>(fRingSeed_reported) << " at cycle " << cyclecount << " with first cycle " << fFirstCycle << endl; - if(fglHelicityScaler) { - cout << "Scaler Seed " << bitset<32>(fglHelicityScaler->GetReportedSeed()) << endl; - } - Int_t backseed = GetSeed30(fRingSeed_reported); - cout << "Seed at cycle " << fFirstCycle << " should be " << hex << backseed << dec << endl; - // Create the "actual seed" - fRingSeed_actual = fRingSeed_reported; - for(Int_t i=0;i<fHelDelay/4; i++) { - fRingSeed_actual = RanBit30(fRingSeed_actual); - } - fQuartetStartHelicity = (fRingSeed_actual&1)?kPlus:kMinus; - fQuartetStartPredictedHelicity = (fRingSeed_reported&1)?kPlus:kMinus; - } else if (fglHelicityScaler && fNBits>2) { // Try the scalers - if(fglHelicityScaler->IsSeedGood()) { - Int_t scalerseed = fglHelicityScaler->GetReportedSeed(); - fRingSeed_reported = RanBit30(scalerseed); - cout << " -- Getting seed from scalers -- " << endl; - cout << " Seed Found " << bitset<32>(fRingSeed_reported) << " at cycle " << cyclecount << " with first cycle " << fFirstCycle << endl; - cout << "Scaler Seed " << bitset<32>(scalerseed) << endl; - // Create the "actual seed" - fRingSeed_actual = fRingSeed_reported; - for(Int_t i=0;i<fHelDelay/4; i++) { - fRingSeed_actual = RanBit30(fRingSeed_actual); - } - fQuartetStartHelicity = (fRingSeed_actual&1)?kPlus:kMinus; - fQuartetStartPredictedHelicity = (fRingSeed_reported&1)?kPlus:kMinus; - fNBits = fMAXBIT+0; - } + if (fReportedHelicity == kUnknown) { + fNBits = 0; + fRingSeed_reported = 0; + } else if (fNBits == fMAXBIT + 0) { + _logger->info("Seed Found {:32b} at cycle {} with first cycle {}", fRingSeed_reported, + cyclecount, fFirstCycle); + if (fglHelicityScaler) { + _logger->info("Scaler Seed {:32b}", fScalerSeed); + } + Int_t backseed = GetSeed30(fRingSeed_reported); + _logger->info("Seed at cycle {} should be {:#x}", fFirstCycle, backseed); + // Create the "actual seed" + fRingSeed_actual = fRingSeed_reported; + for (Int_t i = 0; i < fHelDelay / 4; i++) { + fRingSeed_actual = RanBit30(fRingSeed_actual); + } + fQuartetStartHelicity = (fRingSeed_actual & 1) ? kPlus : kMinus; + fQuartetStartPredictedHelicity = (fRingSeed_reported & 1) ? kPlus : kMinus; + } else if (fglHelicityScaler && fNBits > 2) { // Try the scalers + if (fglHelicityScaler->IsSeedGood()) { + Int_t scalerseed = fglHelicityScaler->GetReportedSeed(); + fRingSeed_reported = RanBit30(scalerseed); + _logger->info(" -- Getting seed from scalers -- "); + cout << " Seed Found " << bitset<32>(fRingSeed_reported) << " at cycle " << cyclecount + << " with first cycle " << fFirstCycle << endl; + cout << "Scaler Seed " << bitset<32>(scalerseed) << endl; + // Create the "actual seed" + fRingSeed_actual = fRingSeed_reported; + for (Int_t i = 0; i < fHelDelay / 4; i++) { + fRingSeed_actual = RanBit30(fRingSeed_actual); + } + fQuartetStartHelicity = (fRingSeed_actual & 1) ? kPlus : kMinus; + fQuartetStartPredictedHelicity = (fRingSeed_reported & 1) ? kPlus : kMinus; + fNBits = fMAXBIT + 0; + } } fActualHelicity = kUnknown; } // Need to change this to build seed even when not at start of quartet } else { - if(quartetphase == 0) { + if (quartetphase == 0) { // If quartetphase !=, the seeds will alread have been advanced - // except that we won't have made the initial + // except that we won't have made the initial // cout << "Advancing seed B " << fNBits << endl; - fRingSeed_reported = RanBit30(fRingSeed_reported); - fRingSeed_actual = RanBit30(fRingSeed_actual); - - fActualHelicity = (fRingSeed_actual&1)?kPlus:kMinus; - fPredictedHelicity = (fRingSeed_reported&1)?kPlus:kMinus; - // if(fTITime/250000000.0 > 380.0) cout << fTITime/250000000.0 << " " << fNCycle << " " << hex << - // fRingSeed_reported << " " << fRingSeed_actual << dec << endl; - if(fReportedHelicity != fPredictedHelicity) { - cout << "Helicity prediction failed " << fReportedHelicity << " " - << fPredictedHelicity << " " << fActualHelicity << endl; - cout << bitset<32>(fRingSeed_reported) << " " << bitset<32>(fRingSeed_actual) << endl; - fNBits = 0; // Need to reaquire seed - fActualHelicity = kUnknown; - fPredictedHelicity = kUnknown; + fRingSeed_reported = RanBit30(fRingSeed_reported); + fRingSeed_actual = RanBit30(fRingSeed_actual); + + fActualHelicity = (fRingSeed_actual & 1) ? kPlus : kMinus; + fPredictedHelicity = (fRingSeed_reported & 1) ? kPlus : kMinus; + // if(fTITime/250000000.0 > 380.0) cout << fTITime/250000000.0 << " " << fNCycle << " " + // << hex << + // fRingSeed_reported << " " << fRingSeed_actual << dec + //<< endl; + if (fReportedHelicity != fPredictedHelicity) { + _logger->warn("Helicity prediction failed {} {} {}", fReportedHelicity, fPredictedHelicity, + fActualHelicity); + _logger->warn("{} {}", fRingSeed_reported, fRingSeed_actual); + fNBits = 0; // Need to reaquire seed + fActualHelicity = kUnknown; + fPredictedHelicity = kUnknown; } - fQuartetStartHelicity = fActualHelicity; + fQuartetStartHelicity = fActualHelicity; fQuartetStartPredictedHelicity = fPredictedHelicity; } - fActualHelicity = (quartetphase==0||quartetphase==3)? - fQuartetStartHelicity:-fQuartetStartHelicity; - fPredictedHelicity = (quartetphase==0||quartetphase==3)? - fQuartetStartPredictedHelicity:-fQuartetStartPredictedHelicity; + fActualHelicity = + (quartetphase == 0 || quartetphase == 3) ? fQuartetStartHelicity : -fQuartetStartHelicity; + fPredictedHelicity = (quartetphase == 0 || quartetphase == 3) ? fQuartetStartPredictedHelicity + : -fQuartetStartPredictedHelicity; } return; } //_____________________________________________________________________________ -Int_t THcHelicity::RanBit30(Int_t ranseed) -{ - - UInt_t bit7 = (ranseed & 0x00000040) != 0; - UInt_t bit28 = (ranseed & 0x08000000) != 0; - UInt_t bit29 = (ranseed & 0x10000000) != 0; - UInt_t bit30 = (ranseed & 0x20000000) != 0; +Int_t THcHelicity::RanBit30(Int_t ranseed) { + + UInt_t bit7 = (ranseed & 0x00000040) != 0; + UInt_t bit28 = (ranseed & 0x08000000) != 0; + UInt_t bit29 = (ranseed & 0x10000000) != 0; + UInt_t bit30 = (ranseed & 0x20000000) != 0; UInt_t newbit = (bit30 ^ bit29 ^ bit28 ^ bit7) & 0x1; - - if(ranseed<=0) { - if(fQWEAKDebug>1) - std::cerr<<"ranseed must be greater than zero!"<<"\n"; + if (ranseed <= 0) { + if (fQWEAKDebug > 1) + std::cerr << "ranseed must be greater than zero!" + << "\n"; newbit = 0; } - ranseed = ( (ranseed<<1) | newbit ) & 0x3FFFFFFF; - //here ranseed is changed - if(fQWEAKDebug>1) - { - cout<< "THcHelicity::RanBit30, newbit="<<newbit<<"\n"; - } + ranseed = ((ranseed << 1) | newbit) & 0x3FFFFFFF; + // here ranseed is changed + if (fQWEAKDebug > 1) { + _logger->info("THcHelicity::RanBit30, newbit={}", newbit); + } return ranseed; - } //_____________________________________________________________________________ -Int_t THcHelicity::GetSeed30(Int_t currentseed) +Int_t THcHelicity::GetSeed30(Int_t currentseed) /* Back track the seed by 30 samples */ { #if 1 Int_t seed = currentseed; - for(Int_t i=0;i<30;i++) { - UInt_t bit1 = (seed & 0x00000001) != 0; - UInt_t bit8 = (seed & 0x00000080) != 0; - UInt_t bit29 = (seed & 0x10000000) != 0; - UInt_t bit30 = (seed & 0x20000000) != 0; - + for (Int_t i = 0; i < 30; i++) { + UInt_t bit1 = (seed & 0x00000001) != 0; + UInt_t bit8 = (seed & 0x00000080) != 0; + UInt_t bit29 = (seed & 0x10000000) != 0; + UInt_t bit30 = (seed & 0x20000000) != 0; + UInt_t newbit30 = (bit30 ^ bit29 ^ bit8 ^ bit1) & 0x1; - seed = (seed >> 1) | (newbit30<<29); + seed = (seed >> 1) | (newbit30 << 29); } #else Int_t bits = currentseed; - Int_t seed=0; - for(Int_t i=0;i<30;i++) { + Int_t seed = 0; + for (Int_t i = 0; i < 30; i++) { Int_t val; // XOR at virtual position 0 and 29 - if(i==0) { - val = ((bits & (1<<(i)))!=0) ^ ((bits & (1<<(i+29)))!=0); + if (i == 0) { + val = ((bits & (1 << (i))) != 0) ^ ((bits & (1 << (i + 29))) != 0); } else { - val = ((bits & (1<<(i)))!=0) ^ ((seed & (1<<(i-1)))!=0); + val = ((bits & (1 << (i))) != 0) ^ ((seed & (1 << (i - 1))) != 0); } - if(i<=1) { - val = ((bits & (1<<(1-i)))!=0) ^ val; + if (i <= 1) { + val = ((bits & (1 << (1 - i))) != 0) ^ val; } else { - val = ((seed & (1<<(i-2)))!=0) ^ val; + val = ((seed & (1 << (i - 2))) != 0) ^ val; } - if(i<=22) { - val = ((bits & (1<<(i-22)))!=0) ^ val; + if (i <= 22) { + val = ((bits & (1 << (i - 22))) != 0) ^ val; } else { - val = ((seed & (1<<(i-23)))!=0) ^ val; + val = ((seed & (1 << (i - 23))) != 0) ^ val; } - seed |= (val<<i); + seed |= (val << i); } #endif return seed; diff --git a/src/THcHelicity.h b/src/THcHelicity.h index 4a03d70e36bc1a0a917617b02d317d7a0c0e3c6d..0856055b0ba0e2a0604075dd8fd6ce2504fbb822 100644 --- a/src/THcHelicity.h +++ b/src/THcHelicity.h @@ -6,11 +6,12 @@ // THcHelicity // // Helicity of the beam - from QWEAK electronics in delayed mode -// +// //////////////////////////////////////////////////////////////////////// #include "THaHelicityDet.h" #include "THcHelicityReader.h" +#include "hcana/Logger.h" class TH1F; class THcHelicityScaler; @@ -18,115 +19,110 @@ class THcHelicityScaler; class THcHelicity : public THaHelicityDet, public THcHelicityReader { public: - - THcHelicity( const char* name, const char* description, - THaApparatus* a = NULL ); + THcHelicity(const char* name, const char* description, THaApparatus* a = NULL); THcHelicity(); virtual ~THcHelicity(); virtual EStatus Init(const TDatime& date); - virtual void MakePrefix(); + virtual void MakePrefix(); - virtual Int_t Begin( THaRunBase* r=0 ); - virtual void Clear( Option_t* opt = "" ); - virtual Int_t Decode( const THaEvData& evdata ); - virtual Int_t End( THaRunBase* r=0 ); - virtual void SetDebug( Int_t level ); - virtual void SetHelicityScaler(THcHelicityScaler *f); + virtual Int_t Begin(THaRunBase* r = 0); + virtual void Clear(Option_t* opt = ""); + virtual Int_t Decode(const THaEvData& evdata); + virtual Int_t End(THaRunBase* r = 0); + virtual void SetDebug(Int_t level); + virtual void SetHelicityScaler(THcHelicityScaler* f); void PrintEvent(Int_t evtnum); protected: - void Setup(const char* name, const char* description); + void Setup(const char* name, const char* description); std::string fKwPrefix; - + void FillHisto(); void LoadHelicity(Int_t reportedhelicity, Int_t cyclecount, Int_t missedcycles); Int_t RanBit30(Int_t ranseed); Int_t GetSeed30(Int_t currentseed); // Fixed Parameters - Int_t fRingSeed_reported_initial; - Int_t fFirstCycle; - Bool_t fFixFirstCycle; + Int_t fRingSeed_reported_initial; + Int_t fFirstCycle; + Bool_t fFixFirstCycle; Double_t fFreq; Double_t fRecommendedFreq; - Double_t fTIPeriod; // Reversal period in TI time units + Double_t fTIPeriod; // Reversal period in TI time units Double_t fPeriodCheck; Double_t fPeriodCheckOffset; Double_t fCycle; - Bool_t fFirstEvProcessed; - Int_t fLastReportedHelicity; + Bool_t fFirstEvProcessed; + Int_t fLastReportedHelicity; Long64_t fFirstEvTime; Long64_t fLastEvTime; Long64_t fLastMPSTime; - Int_t fReportedHelicity; - Int_t fMPS; - Int_t fPredictedHelicity; - Int_t fActualHelicity; - Int_t fQuartetStartHelicity; - Int_t fQuartetStartPredictedHelicity; - Bool_t fFoundMPS; - Bool_t fFoundQuartet; // True if quartet phase probably found. - Bool_t fIsNewCycle; - Int_t fNCycle; // Count of # of helicity cycles - Int_t fNQuartet; // Quartet count - Int_t fNLastQuartet; - Int_t fQuartet[4]; // For finding and checking quartet pattern - Int_t fNBits; - Int_t fnQrt; // Position in quartet - Bool_t fHaveQRT; // QRT signal exists - Int_t fNQRTProblems; + Int_t fReportedHelicity; + Int_t fMPS; + Int_t fPredictedHelicity; + Int_t fActualHelicity; + Int_t fQuartetStartHelicity; + Int_t fQuartetStartPredictedHelicity; + Bool_t fFoundMPS; + Bool_t fFoundQuartet; // True if quartet phase probably found. + Bool_t fIsNewCycle; + Int_t fNCycle; // Count of # of helicity cycles + Int_t fNQuartet; // Quartet count + Int_t fNLastQuartet; + Int_t fQuartet[4]; // For finding and checking quartet pattern + Int_t fNBits; + Int_t fnQrt; // Position in quartet + Bool_t fHaveQRT; // QRT signal exists + Int_t fNQRTProblems; Int_t fRingSeed_reported; Int_t fRingSeed_actual; - // Offset between the ring reported value and the reported value - Int_t fHelDelay; + Int_t fHelDelay; // delay of helicity (# windows) - Int_t fMAXBIT; - //number of bit in the pseudo random helcity generator + Int_t fMAXBIT; + // number of bit in the pseudo random helcity generator std::vector<Int_t> fPatternSequence; // sequence of 0 and 1 in the pattern - Int_t fQWEAKNPattern; // maximum of event in the pattern - Bool_t HWPIN; - + Int_t fQWEAKNPattern; // maximum of event in the pattern + Bool_t HWPIN; Int_t fQrt; - void SetErrorCode(Int_t error); + void SetErrorCode(Int_t error); Double_t fErrorCode; - - Int_t fEvtype; // Current CODA event type - Int_t fLastActualHelicity; - Int_t fEvNumCheck; + + Int_t fEvtype; // Current CODA event type + Int_t fLastActualHelicity; + Int_t fEvNumCheck; Bool_t fDisabled; - - static const Int_t NHIST = 2; - TH1F* fHisto[NHIST]; - - virtual Int_t DefineVariables( EMode mode = kDefine ); - virtual Int_t ReadDatabase( const TDatime& date ); - - THcHelicityScaler *fglHelicityScaler; - Int_t* fHelicityHistory; - Int_t fLastHelpCycle; - Int_t fScaleQuartet; - Int_t fQuadPattern[8]; - Int_t fHelperHistory; - Int_t fHelperQuartetHistory; - Int_t fScalerSeed; - Int_t lastispos; - Int_t evnum; - Int_t fThisScaleHel; - Int_t fLastScaleHel; - Int_t fLastLastScaleHel; - - ClassDef(THcHelicity,0) // Beam helicity from QWEAK electronics in delayed mode + static const Int_t NHIST = 2; + TH1F* fHisto[NHIST]; + + virtual Int_t DefineVariables(EMode mode = kDefine); + virtual Int_t ReadDatabase(const TDatime& date); + + THcHelicityScaler* fglHelicityScaler = nullptr; + Int_t* fHelicityHistory = nullptr; + Int_t fLastHelpCycle; + Int_t fScaleQuartet; + Int_t fQuadPattern[8]; + Int_t fHelperHistory; + Int_t fHelperQuartetHistory; + Int_t fScalerSeed; + Int_t lastispos; + Int_t evnum; + Int_t fThisScaleHel; + Int_t fLastScaleHel; + Int_t fLastLastScaleHel; + + ClassDef(THcHelicity, 0) // Beam helicity from QWEAK electronics in delayed mode }; #endif diff --git a/src/THcHelicityReader.cxx b/src/THcHelicityReader.cxx index 5d38099c1b2f176c8150981d36537517063b269b..d6ad9a1e7e5f701f4cbb8f8bfb693badfb7922ed 100644 --- a/src/THcHelicityReader.cxx +++ b/src/THcHelicityReader.cxx @@ -7,30 +7,28 @@ //////////////////////////////////////////////////////////////////////// #include "THcHelicityReader.h" +#include "TError.h" +#include "TH1F.h" +#include "THaAnalysisObject.h" // For LoadDB #include "THaEvData.h" #include "THcGlobals.h" #include "THcParmList.h" #include "TMath.h" -#include "TError.h" #include "VarDef.h" -#include "THaAnalysisObject.h" // For LoadDB +#include "hcana/Logger.h" #include <iostream> #include <vector> -#include "TH1F.h" using namespace std; //____________________________________________________________________ THcHelicityReader::THcHelicityReader() - : fTITime(0), fTITime_last(0), fTITime_rollovers(0), - fHaveROCs(kFALSE) -{ + : hcana::ConfigLogging<podd2::EmptyBase>(), fTITime(0), fTITime_last(0), fTITime_rollovers(0), + fHaveROCs(kFALSE) { // Default constructor - } //____________________________________________________________________ -THcHelicityReader::~THcHelicityReader() -{ +THcHelicityReader::~THcHelicityReader() { // Destructor // Histograms will be deleted by ROOT @@ -40,36 +38,26 @@ THcHelicityReader::~THcHelicityReader() } //____________________________________________________________________ -void THcHelicityReader::Clear( Option_t* ) -{ - - fIsMPS = fIsQrt = fIsHelp = fIsHelm = kFALSE; - -} +void THcHelicityReader::Clear(Option_t*) { fIsMPS = fIsQrt = fIsHelp = fIsHelm = kFALSE; } //_____________________________________________________________________________ -Int_t THcHelicityReader::ReadDatabase( const char* /*dbfilename*/, - const char* /*prefix*/, - const TDatime& /*date*/, - int /*debug_flag*/ ) -{ +Int_t THcHelicityReader::ReadDatabase(const char* /*dbfilename*/, const char* /*prefix*/, + const TDatime& /*date*/, int /*debug_flag*/) { // Eventually get these from the parameter file + const static char* const here = "THcHelicityReader::ReadDatabase"; // SHMS settings see https://logbooks.jlab.org/entry/3614445 - cout << "THcHelicityReader: Helicity information from ROC 2 (SHMS)" << endl; - SetROCinfo(kHel,2,14,9); - SetROCinfo(kHelm,2,14,8); - SetROCinfo(kMPS,2,14,10); - SetROCinfo(kQrt,2,14,7); // Starting about run 5818 - SetROCinfo(kTime,2,21,2); - + _logger->info("{}: Helicity information from ROC 2 (SHMS)", here); + SetROCinfo(kHel, 2, 14, 9); + SetROCinfo(kHelm, 2, 14, 8); + SetROCinfo(kMPS, 2, 14, 10); + SetROCinfo(kQrt, 2, 14, 7); // Starting about run 5818 + SetROCinfo(kTime, 2, 21, 2); + fADCThreshold = 8000; - - DBRequest list[] = { - {"helicity_adcthreshold",&fADCThreshold, kInt, 0, 1}, - {0} - }; + + DBRequest list[] = {{"helicity_adcthreshold", &fADCThreshold, kInt, 0, 1}, {0}}; gHcParms->LoadParmValues(list, ""); @@ -77,28 +65,25 @@ Int_t THcHelicityReader::ReadDatabase( const char* /*dbfilename*/, } //_____________________________________________________________________________ -void THcHelicityReader::Begin() -{ +void THcHelicityReader::Begin() { // static const char* const here = "THcHelicityReader::Begin"; // cout<<here<<endl; - fTITime_last = 0; - fTITime = 0; + fTITime_last = 0; + fTITime = 0; fTITime_rollovers = 0; return; } //____________________________________________________________________ -void THcHelicityReader::End() -{ +void THcHelicityReader::End() { // static const char* const here = "THcHelicityReader::End"; // cout<<here<<endl; return; } //____________________________________________________________________ -Int_t THcHelicityReader::ReadData( const THaEvData& evdata ) -{ +Int_t THcHelicityReader::ReadData(const THaEvData& evdata) { // Obtain the present data from the event for QWEAK helicity mode. static const char* here = "THcHelicityReader::ReadData"; @@ -109,52 +94,48 @@ Int_t THcHelicityReader::ReadData( const THaEvData& evdata ) // std::cout<<" which="<<jk // <<" roc="<<fROCinfo[jk].roc // <<" header="<<fROCinfo[jk].header - // <<" index="<<fROCinfo[jk].index + // <<" index="<<fROCinfo[jk].index // <<endl; // } - + // std::cout<<" fHaveROCs="<<fHaveROCs<<endl; - if( !fHaveROCs ) { - ::Error( here, "ROC data (detector map) not properly set up." ); + if (!fHaveROCs) { + ::Error(here, "ROC data (detector map) not properly set up."); return -1; } // Check if ROC info is correct - if(!evdata.GetModule(fROCinfo[kTime].roc, fROCinfo[kTime].slot)) { - cout << "THcHelicityReader: ROC 2 not found" << endl; - cout << "Changing to ROC 1 (HMS)" << endl; - SetROCinfo(kHel,1,18,9); - SetROCinfo(kHelm,1,18,8); - SetROCinfo(kMPS,1,18,10); - SetROCinfo(kQrt,1,18,7); - SetROCinfo(kTime,1,21,2); + if (!evdata.GetModule(fROCinfo[kTime].roc, fROCinfo[kTime].slot)) { + _logger->info("{}: ROC 2 not found, changing to ROC 1 (HMS)", here); + SetROCinfo(kHel, 1, 18, 9); + SetROCinfo(kHelm, 1, 18, 8); + SetROCinfo(kMPS, 1, 18, 10); + SetROCinfo(kQrt, 1, 18, 7); + SetROCinfo(kTime, 1, 21, 2); } // Get the TI Data // Int_t fTIType = evData.GetData(fTICrate, fTISlot, 0, 0); // Int_t fTIEvNum = evData.GetData(fTICrate, fTISlot, 1, 0); - UInt_t titime = (UInt_t) evdata.GetData(fROCinfo[kTime].roc, - fROCinfo[kTime].slot, - fROCinfo[kTime].index, 0); + UInt_t titime = + (UInt_t)evdata.GetData(fROCinfo[kTime].roc, fROCinfo[kTime].slot, fROCinfo[kTime].index, 0); // Check again if ROC info is correct - if(titime == 0 && fTITime_last==0) { - cout << "THcHelicityReader: ROC 2 not found" << endl; - cout << "Changing to ROC 1 (HMS)" << endl; - SetROCinfo(kHel,1,18,9); - SetROCinfo(kHelm,1,18,8); - SetROCinfo(kMPS,1,18,10); - SetROCinfo(kQrt,1,18,7); - SetROCinfo(kTime,1,21,2); - titime = (UInt_t) evdata.GetData(fROCinfo[kTime].roc, - fROCinfo[kTime].slot, - fROCinfo[kTime].index, 0); - } - //cout << fTITime_last << " " << titime << endl; - if(titime < fTITime_last) { + if (titime == 0 && fTITime_last == 0) { + _logger->info("{}: ROC 2 not found, changing to ROC 1 (HMS)", here); + SetROCinfo(kHel, 1, 18, 9); + SetROCinfo(kHelm, 1, 18, 8); + SetROCinfo(kMPS, 1, 18, 10); + SetROCinfo(kQrt, 1, 18, 7); + SetROCinfo(kTime, 1, 21, 2); + titime = + (UInt_t)evdata.GetData(fROCinfo[kTime].roc, fROCinfo[kTime].slot, fROCinfo[kTime].index, 0); + } + // cout << fTITime_last << " " << titime << endl; + if (titime < fTITime_last) { fTITime_rollovers++; } - fTITime = titime + fTITime_rollovers*4294967296; + fTITime = titime + fTITime_rollovers * 4294967296; fTITime_last = titime; const_cast<THaEvData&>(evdata).SetEvTime(fTITime); @@ -162,36 +143,26 @@ Int_t THcHelicityReader::ReadData( const THaEvData& evdata ) // Get the helicity control signals. These are from the pedestals // acquired by FADC channels. - Int_t helpraw = evdata.GetData(Decoder::kPulsePedestal, - fROCinfo[kHel].roc, - fROCinfo[kHel].slot, - fROCinfo[kHel].index, 0); - Int_t helmraw = evdata.GetData(Decoder::kPulsePedestal, - fROCinfo[kHelm].roc, - fROCinfo[kHelm].slot, - fROCinfo[kHelm].index, 0); - Int_t mpsraw = evdata.GetData(Decoder::kPulsePedestal, - fROCinfo[kMPS].roc, - fROCinfo[kMPS].slot, - fROCinfo[kMPS].index, 0); - Int_t qrtraw = evdata.GetData(Decoder::kPulsePedestal, - fROCinfo[kQrt].roc, - fROCinfo[kQrt].slot, - fROCinfo[kQrt].index, 0); - - fIsQrt = qrtraw > fADCThreshold; - fIsMPS = mpsraw > fADCThreshold; + Int_t helpraw = evdata.GetData(Decoder::kPulsePedestal, fROCinfo[kHel].roc, fROCinfo[kHel].slot, + fROCinfo[kHel].index, 0); + Int_t helmraw = evdata.GetData(Decoder::kPulsePedestal, fROCinfo[kHelm].roc, fROCinfo[kHelm].slot, + fROCinfo[kHelm].index, 0); + Int_t mpsraw = evdata.GetData(Decoder::kPulsePedestal, fROCinfo[kMPS].roc, fROCinfo[kMPS].slot, + fROCinfo[kMPS].index, 0); + Int_t qrtraw = evdata.GetData(Decoder::kPulsePedestal, fROCinfo[kQrt].roc, fROCinfo[kQrt].slot, + fROCinfo[kQrt].index, 0); + + fIsQrt = qrtraw > fADCThreshold; + fIsMPS = mpsraw > fADCThreshold; fIsHelp = helpraw > fADCThreshold; fIsHelm = helmraw > fADCThreshold; return 0; } -//TODO: this should not be needed once LoadDB can fill fROCinfo directly +// TODO: this should not be needed once LoadDB can fill fROCinfo directly //____________________________________________________________________ -Int_t THcHelicityReader::SetROCinfo( EROC which, Int_t roc, - Int_t slot, Int_t index ) -{ +Int_t THcHelicityReader::SetROCinfo(EROC which, Int_t roc, Int_t slot, Int_t index) { // Define source and offset of data. Normally called by ReadDatabase // of the detector that is a THcHelicityReader. @@ -200,19 +171,19 @@ Int_t THcHelicityReader::SetROCinfo( EROC which, Int_t roc, // You must define at least the kHel and kTime ROCs. // Returns <0 if parameter error, 0 if success - if( which<kHel || which>=kCount ) + if (which < kHel || which >= kCount) return -1; - if( roc <= 0 || roc > 255 ) + if (roc <= 0 || roc > 255) return -2; - fROCinfo[which].roc = roc; - fROCinfo[which].slot = slot; - fROCinfo[which].index = index; + fROCinfo[which].roc = roc; + fROCinfo[which].slot = slot; + fROCinfo[which].index = index; - cout << "SetROCInfo: " << which << " " << fROCinfo[which].roc << " " << fROCinfo[which].slot << - " " << fROCinfo[which].index << endl; + _logger->info("SetROCInfo: {} (roc: {}, slot: {}, index: {})", which, fROCinfo[which].roc, + fROCinfo[which].slot, fROCinfo[which].index); fHaveROCs = (fROCinfo[kHel].roc > 0 && fROCinfo[kTime].roc > 0 && fROCinfo[kMPS].roc); - + return 0; } diff --git a/src/THcHelicityReader.h b/src/THcHelicityReader.h index eef01503732231f90dfbca4132c3128e4dcf591f..b782da17e7bf5726a980963d84807a3f1eb65d4a 100644 --- a/src/THcHelicityReader.h +++ b/src/THcHelicityReader.h @@ -10,60 +10,59 @@ ////////////////////////////////////////////////////////////////////////// #include "Rtypes.h" +#include "THaHelicityDet.h" +#include "hcana/Logger.h" class THaEvData; class TDatime; class TH1F; -class THcHelicityReader { - +class THcHelicityReader : public hcana::ConfigLogging<podd2::EmptyBase> { + public: THcHelicityReader(); virtual ~THcHelicityReader(); - + struct ROCinfo { - Int_t roc; // ROC to read out - Int_t slot; // Headers to search for (0 = ignore) - Int_t index; // Index into buffer + Int_t roc; // ROC to read out + Int_t slot; // Headers to search for (0 = ignore) + Int_t index; // Index into buffer }; - -protected: +protected: // Used by ReadDatabase enum EROC { kHel = 0, kHelm, kMPS, kQrt, kTime, kCount }; - Int_t SetROCinfo( EROC which, Int_t roc, Int_t slot, Int_t index ); + Int_t SetROCinfo(EROC which, Int_t roc, Int_t slot, Int_t index); - virtual void Clear( Option_t* opt="" ); - virtual Int_t ReadData( const THaEvData& evdata ); - Int_t ReadDatabase( const char* dbfilename, const char* prefix, - const TDatime& date, int debug_flag = 0 ); - void Begin(); - void End(); + virtual void Clear(Option_t* opt = ""); + virtual Int_t ReadData(const THaEvData& evdata); + Int_t ReadDatabase(const char* dbfilename, const char* prefix, const TDatime& date, + int debug_flag = 0); + void Begin(); + void End(); ULong64_t fTITime; - UInt_t fTITime_last; - UInt_t fTITime_rollovers; - + UInt_t fTITime_last; + UInt_t fTITime_rollovers; + // Reported Helicity status for the event Bool_t fIsMPS; Bool_t fIsQrt; Bool_t fIsHelp; Bool_t fIsHelm; - Int_t fADCThreshold; // Threshold for On/Off of helicity signals + Int_t fADCThreshold; // Threshold for On/Off of helicity signals - ROCinfo fROCinfo[kCount]; + ROCinfo fROCinfo[kCount]; - Int_t fQWEAKDebug; // Debug level - Bool_t fHaveROCs; // Required ROCs are defined - Bool_t fNegGate; // Invert polarity of gate, TO DO implement this functionality + Int_t fQWEAKDebug; // Debug level + Bool_t fHaveROCs; // Required ROCs are defined + Bool_t fNegGate; // Invert polarity of gate, TO DO implement this functionality static const Int_t NHISTR = 12; // TH1F* fHistoR[12]; // Histograms private: - - ClassDef(THcHelicityReader,0) // Helper class for reading QWEAK helicity data - + ClassDef(THcHelicityReader, 0) // Helper class for reading QWEAK helicity data }; #endif diff --git a/src/THcHelicityScaler.cxx b/src/THcHelicityScaler.cxx index 058aa0714ee509efeccc9ecfa5130d95881e77fb..13423a6cc88269cffa2c8c9ec9220d9939e29d19 100644 --- a/src/THcHelicityScaler.cxx +++ b/src/THcHelicityScaler.cxx @@ -11,53 +11,62 @@ hhelscaler->SetBankID(0x9801); // Will default to this gHaEvtHandlers->Add (hhelscaler); ~~~ -\author +\author */ +#include <cstdio> +#include <cstdlib> +#include <cstring> +#include <iomanip> +#include <iostream> +#include <iterator> +#include <sstream> +#include <unordered_map> + +#include "TMath.h" +#include "TNamed.h" +#include "TROOT.h" +#include "TString.h" //#include "THaEvtTypeHandler.h" -#include "THcHelicityScaler.h" #include "THaCodaData.h" #include "THaEvData.h" -#include "THcGlobals.h" #include "THaGlobals.h" -#include "THcParmList.h" +#include "THcGlobals.h" #include "THcHelicity.h" -#include "TNamed.h" -#include "TMath.h" -#include "TString.h" -#include "TROOT.h" -#include <cstring> -#include <cstdio> -#include <cstdlib> -#include <iostream> -#include <sstream> -#include <map> -#include <bitset> -#include <iterator> +#include "THcHelicityScaler.h" +#include "THcParmList.h" + + +#include "Helper.h" #include "THaVarList.h" #include "VarDef.h" -#include "Helper.h" +#include "nlohmann/json.hpp" + +using nlohmann::json; using namespace std; using namespace Decoder; static const UInt_t ICOUNT = 1; static const UInt_t IRATE = 2; -static const UInt_t ICURRENT = 3; +static const UInt_t ICURRENT = 3; static const UInt_t ICHARGE = 4; -static const UInt_t ITIME = 5; -static const UInt_t ICUT = 6; +static const UInt_t ITIME = 5; +static const UInt_t ICUT = 6; static const UInt_t MAXCHAN = 32; static const UInt_t defaultDT = 4; -THcHelicityScaler::THcHelicityScaler(const char *name, const char* description) - : THaEvtTypeHandler(name,description), - fBankID(9801), - fUseFirstEvent(kTRUE), - fDelayedType(-1), - fBCM_Gain(0), fBCM_Offset(0) -{ - fROC=-1; +// Compute Charge Asymmetries +static std::unordered_map<std::string, Int_t> bcmindex = { + {"BCM1", 0}, {"BCM2", 2}, {"Unser", 6}, {"BCM4A", 10}, {"BCM4B", 4}, {"BCM4C", 12}, {"1MHz", 8}, +}; +static const Int_t clockindex = 8; +static const Double_t clockfreq = 1000000.0; + +THcHelicityScaler::THcHelicityScaler(const char* name, const char* description) + : hcana::ConfigLogging<THaEvtTypeHandler>(name, description), fBankID(9801), + fUseFirstEvent(kTRUE), fDelayedType(-1) { + fROC = -1; fNScalerChannels = 32; AddEvtType(1); @@ -67,52 +76,49 @@ THcHelicityScaler::THcHelicityScaler(const char *name, const char* description) AddEvtType(6); AddEvtType(7); SetDelayedType(129); - } -THcHelicityScaler::~THcHelicityScaler() -{ - delete [] fBCM_Gain; - delete [] fBCM_Offset; - - for( vector<UInt_t*>::iterator it = fDelayedEvents.begin(); - it != fDelayedEvents.end(); ++it ) - delete [] *it; +THcHelicityScaler::~THcHelicityScaler() { + for (vector<UInt_t*>::iterator it = fDelayedEvents.begin(); it != fDelayedEvents.end(); ++it) + delete[] * it; fDelayedEvents.clear(); } -Int_t THcHelicityScaler::End( THaRunBase* ) -{ +Int_t THcHelicityScaler::End(THaRunBase* runbase) { // Process any delayed events in order received + const static char* const here = "THcHelicityScaler::End"; + _param_logger->info("{} Analyzing {} delayed helicity scaler events", here, + fDelayedEvents.size()); + for (auto it = fDelayedEvents.begin(); it != fDelayedEvents.end(); ++it) { - cout << "THcHelicityScaler::End Analyzing " << fDelayedEvents.size() << " delayed helicity scaler events" << endl; - for(std::vector<UInt_t*>::iterator it = fDelayedEvents.begin(); - it != fDelayedEvents.end(); ++it) { UInt_t* rdata = *it; AnalyzeBuffer(rdata); } - for( vector<UInt_t*>::iterator it = fDelayedEvents.begin(); - it != fDelayedEvents.end(); ++it ) - delete [] *it; + for (auto it = fDelayedEvents.begin(); it != fDelayedEvents.end(); ++it) { + delete[] * it; + } fDelayedEvents.clear(); // cout << " -- Helicity Scalers -- " << endl; - for(Int_t i=0;i<fNScalerChannels;i++) { - if(fScalerSums[i]>0.5) { - fAsymmetry[i] = (fHScalers[0][i]-fHScalers[1][i])/fScalerSums[i]; - fAsymmetryError[i] = 2*TMath::Sqrt(fHScalers[0][i]*fHScalers[1][i] - *fScalerSums[i]) - /(fScalerSums[i]*fScalerSums[i]); + for (Int_t i = 0; i < fNScalerChannels; i++) { + if (fScalerSums[i] > 0.5) { + fAsymmetry[i] = (fHScalers[0][i] - fHScalers[1][i]) / fScalerSums[i]; + fAsymmetryError[i] = 2 * TMath::Sqrt(fHScalers[0][i] * fHScalers[1][i] * fScalerSums[i]) / + (fScalerSums[i] * fScalerSums[i]); } else { - fAsymmetry[i] = 0.0; + fAsymmetry[i] = 0.0; fAsymmetryError[i] = 0.0; } // printf("%2d %12.0f %12.0f %12.0f %12.8f\n",i,fScalerSums[i], - // fHScalers[0][i],fHScalers[1][i], - // fAsymmetry[i]); + // fHScalers[0][i],fHScalers[1][i], + // fAsymmetry[i]); } // cout << " ---------------------- " << endl; + // json dump of helicity charge info + json j_helicity; + int run_number = runbase->GetNumber(); + j_helicity["run_number"] = run_number; // Compute Charge Asymmetries std::map<std::string, Int_t> bcmindex; @@ -123,74 +129,79 @@ Int_t THcHelicityScaler::End( THaRunBase* ) bcmindex["BCM4B"] = 4; bcmindex["BCM4C"] = 12; // bcmindex["1MHz"] = 8; - Int_t clockindex=8; - Double_t clockfreq=1000000.0; + Int_t clockindex = 8; + Double_t clockfreq = 1000000.0; + Double_t pclock = fHScalers[0][clockindex]; Double_t mclock = fHScalers[1][clockindex]; - cout << " -- Beam Charge Asymmetries -- " << endl; - for(Int_t i=0;i<fNumBCMs;i++) { - if(bcmindex.find(fBCM_Name[i]) != bcmindex.end()) { - Int_t index=bcmindex[fBCM_Name[i]]; + _param_logger->info("{}: -- Beam Charge Asymmetries -- ", here); + for (Int_t i = 0; i < fNumBCMs; i++) { + if (bcmindex.find(fBCM_Name[i]) != bcmindex.end()) { + Int_t index = bcmindex[fBCM_Name[i]]; Double_t pcounts = fHScalers[0][index]; Double_t mcounts = fHScalers[1][index]; // cout << index << " " << fBCM_Name[i] << " " << pcounts << " " << mcounts - // << " " << fBCM_Gain[i] - // << " " << fBCM_Offset[i] << endl; - Double_t pcharge = (pcounts - (pclock/clockfreq)*fBCM_Offset[i]) - /fBCM_Gain[i]; - Double_t mcharge = (mcounts - (mclock/clockfreq)*fBCM_Offset[i]) - /fBCM_Gain[i]; - fCharge[i] = pcharge+mcharge; - if(fCharge[i]>0.0) { - fChargeAsymmetry[i] = (pcharge-mcharge)/fCharge[i]; + // << " " << fBCM_Gain[i] + // << " " << fBCM_Offset[i] << endl; + Double_t pcharge = (pcounts - (pclock / clockfreq) * fBCM_Offset[i]) / fBCM_Gain[i]; + Double_t mcharge = (mcounts - (mclock / clockfreq) * fBCM_Offset[i]) / fBCM_Gain[i]; + fCharge[i] = pcharge + mcharge; + if (fCharge[i] > 0.0) { + fChargeAsymmetry[i] = (pcharge - mcharge) / fCharge[i]; } else { - fChargeAsymmetry[i] = 0.0; + fChargeAsymmetry[i] = 0.0; } - printf("%6s %12.2f %12.8f\n",fBCM_Name[i].c_str(),fCharge[i],fChargeAsymmetry[i]); + _param_logger->info("{:10} {:12.2f} uC {:12.2f} ppm", fBCM_Name[i], fCharge[i], + fChargeAsymmetry[i] * 1e6); + j_helicity[fBCM_Name[i]] = {{"charge", fCharge[i]}, + {"charge_asymmetry", fChargeAsymmetry[i]}}; } } - fTime = (pclock+mclock)/clockfreq; - if(pclock+mclock>0) { - fTimeAsymmetry = (pclock-mclock)/(pclock+mclock); + + fTime = (pclock + mclock) / clockfreq; + if (pclock + mclock > 0) { + fTimeAsymmetry = (pclock - mclock) / (pclock + mclock); } else { fTimeAsymmetry = 0.0; } - printf("TIME(s)%12.2f %12.8f\n",fTime,fTimeAsymmetry); - if(fNTriggersPlus+fNTriggersMinus > 0) { - fTriggerAsymmetry = ((Double_t) (fNTriggersPlus-fNTriggersMinus))/(fNTriggersPlus+fNTriggersMinus); + j_helicity["clock"] = {{"time", fTime}, {"time_asymmetry", fTimeAsymmetry}}; + _param_logger->info("{:10} {:12.2f} uC {:12.8f} ppm", "TIME(s)", fTime, fTimeAsymmetry); + if (fNTriggersPlus + fNTriggersMinus > 0) { + fTriggerAsymmetry = + ((Double_t)(fNTriggersPlus - fNTriggersMinus)) / (fNTriggersPlus + fNTriggersMinus); } else { fTriggerAsymmetry = 0.0; } - cout << " ----------------------------- " << endl; + j_helicity["triggers"] = {{"N_triggers", fTime}, {"trigger_asymmetry", fTriggerAsymmetry}}; + _param_logger->info("{}: -- Beam Charge Asymmetries End --", here); + + { + std::ofstream json_output_file(fmt::format("hel_scalers_{}.json", run_number)); + json_output_file << std::setw(4) << j_helicity << "\n"; + } + return 0; } - -Int_t THcHelicityScaler::ReadDatabase(const TDatime& date ) -{ +Int_t THcHelicityScaler::ReadDatabase(const TDatime& date) { char prefix[2]; - prefix[0]='g'; prefix[1]='\0'; + prefix[0] = 'g'; + prefix[1] = '\0'; fNumBCMs = 0; - string bcm_namelist; - DBRequest list[]={ - {"NumBCMs",&fNumBCMs, kInt, 0, 1}, - {"BCM_Names", &bcm_namelist, kString}, - {0} - }; + string bcm_namelist; + DBRequest list[] = { + {"NumBCMs", &fNumBCMs, kInt, 0, 1}, {"BCM_Names", &bcm_namelist, kString}, {0}}; gHcParms->LoadParmValues((DBRequest*)&list, prefix); - if(fNumBCMs > 0) { - fBCM_Gain = new Double_t[fNumBCMs]; - fBCM_Offset = new Double_t[fNumBCMs]; - DBRequest list2[]={ - {"BCM_Gain", fBCM_Gain, kDouble, (UInt_t) fNumBCMs}, - {"BCM_Offset", fBCM_Offset, kDouble,(UInt_t) fNumBCMs}, - {0} - }; + if (fNumBCMs > 0) { + fBCM_Gain.resize(fNumBCMs); + fBCM_Offset.resize(fNumBCMs); + DBRequest list2[] = {{"BCM_Gain", &fBCM_Gain[0], kDouble, (UInt_t)fNumBCMs}, + {"BCM_Offset", &fBCM_Offset[0], kDouble, (UInt_t)fNumBCMs}, + {0}}; gHcParms->LoadParmValues((DBRequest*)&list2, prefix); fBCM_Name = vsplit(bcm_namelist); } - return kOK; } void THcHelicityScaler::SetDelayedType(int evtype) { @@ -204,67 +215,71 @@ void THcHelicityScaler::SetDelayedType(int evtype) { */ fDelayedType = evtype; } - -Int_t THcHelicityScaler::Analyze(THaEvData *evdata) -{ - if ( !IsMyEvent(evdata->GetEvType()) ) return -1; +Int_t THcHelicityScaler::Analyze(THaEvData* evdata) { + + if (!IsMyEvent(evdata->GetEvType())) + return -1; if (fDebugFile) { - *fDebugFile << endl << "---------------------------------- "<<endl<<endl; - *fDebugFile << "\nEnter THcHelicityScaler for fName = "<<fName<<endl; + *fDebugFile << endl << "---------------------------------- " << endl << endl; + *fDebugFile << "\nEnter THcHelicityScaler for fName = " << fName << endl; EvDump(evdata); } - UInt_t *rdata = (UInt_t*) evdata->GetRawDataBuffer(); - - if(evdata->GetEvType() == fDelayedType) { // Save this event for processing later - Int_t evlen = evdata->GetEvLength(); - UInt_t *datacopy = new UInt_t[evlen]; + UInt_t* rdata = (UInt_t*)evdata->GetRawDataBuffer(); + + if (evdata->GetEvType() == fDelayedType) { // Save this event for processing later + Int_t evlen = evdata->GetEvLength(); + UInt_t* datacopy = new UInt_t[evlen]; fDelayedEvents.push_back(datacopy); - memcpy(datacopy,rdata,evlen*sizeof(UInt_t)); + memcpy(datacopy, rdata, evlen * sizeof(UInt_t)); return 1; - } else { // A normal event - if (fDebugFile) *fDebugFile<<"\n\nTHcHelicityScaler :: Debugging event type "<<dec<<evdata->GetEvType()<< " event num = " << evdata->GetEvNum() << endl<<endl; - evNumber=evdata->GetEvNum(); + } else { // A normal event + if (fDebugFile) + *fDebugFile << "\n\nTHcHelicityScaler :: Debugging event type " << dec << evdata->GetEvType() + << " event num = " << evdata->GetEvNum() << endl + << endl; + evNumber = evdata->GetEvNum(); Int_t ret; - if((ret=AnalyzeBuffer(rdata))) { + if ((ret = AnalyzeBuffer(rdata))) { // } return ret; } - } -Int_t THcHelicityScaler::AnalyzeBuffer(UInt_t* rdata) -{ - fNTrigsInBuf = 0; +Int_t THcHelicityScaler::AnalyzeBuffer(UInt_t* rdata) { + fNTrigsInBuf = 0; + const static char* const here = "THcHelicityScaler::AnalyzeBuffer"; // Parse the data, load local data arrays. - UInt_t *p = (UInt_t*) rdata; + UInt_t* p = (UInt_t*)rdata; - UInt_t *plast = p+*p; // Index to last word in the bank - Int_t roc = -1; - Int_t evlen = *p+1; + UInt_t* plast = p + *p; // Index to last word in the bank + Int_t roc = -1; + Int_t evlen = *p + 1; - Int_t ifound=0; - - while(p<plast) { + Int_t ifound = 0; + while (p < plast) { Int_t banklen = *p; - p++; // point to header + p++; // point to header if (fDebugFile) { - *fDebugFile << "Bank: " << hex << *p << dec << " len: " << *(p-1) << endl; + *fDebugFile << "Bank: " << hex << *p << dec << " len: " << *(p - 1) << endl; } - if((*p & 0xff00) == 0x1000) { // Bank Containing banks - if(evlen-*(p-1) > 1) { // Don't use overall event header - roc = (*p>>16) & 0xf; - if(fDebugFile) *fDebugFile << "ROC: " << roc << " " << evlen << " " << *(p-1) << hex << " " << *p << dec << endl; -// cout << "ROC: " << roc << " " << evlen << " " << *(p-1) << hex << " " << *p << dec << endl; - if(roc != fROC) { // Not a ROC with helicity scaler - p+=*(p-1)-1; // Skip to next ROC - } + if ((*p & 0xff00) == 0x1000) { // Bank Containing banks + if (evlen - *(p - 1) > 1) { // Don't use overall event header + roc = (*p >> 16) & 0xf; + if (fDebugFile) + *fDebugFile << "ROC: " << roc << " " << evlen << " " << *(p - 1) << hex << " " << *p + << dec << endl; + // cout << "ROC: " << roc << " " << evlen << " " << *(p-1) << hex << " " << + // *p << dec << endl; + if (roc != fROC) { // Not a ROC with helicity scaler + p += *(p - 1) - 1; // Skip to next ROC + } } - p++; // Now pointing to a bank in the bank + p++; // Now pointing to a bank in the bank } else if (((*p & 0xff00) == 0x100) && (*p != 0xC0000100)) { // Bank containing integers. Look for scalers // This is either ROC bank containing integers or @@ -273,138 +288,133 @@ Int_t THcHelicityScaler::AnalyzeBuffer(UInt_t* rdata) // Assume that very first word is a scaler header // At any point in the bank where the word is not a matching // header, we stop. - UInt_t tag = (*p>>16) & 0xffff; // Bank ID (ROC #) - // UInt_t num = (*p) & 0xff; - UInt_t *pnext = p+banklen; // Next bank - p++; // First data word + UInt_t tag = (*p >> 16) & 0xffff; // Bank ID (ROC #) + // UInt_t num = (*p) & 0xff; + UInt_t* pnext = p + banklen; // Next bank + p++; // First data word // If the bank is not a helicity scaler bank // or it is not one of the ROC containing helcity scaler data // skip to the next bank - //cout << "BankID=" << tag << endl; + // cout << "BankID=" << tag << endl; if (tag != fBankID) { - p = pnext; // Fall through to end of the above else if - // cout << " Skipping to next bank" << endl; + p = pnext; // Fall through to end of the above else if + // cout << " Skipping to next bank" << endl; } else { - // This is a helicity scaler bank - if (roc == fROC) { - Int_t nevents = (banklen-2)/fNScalerChannels; - //cout << "# of helicity events in bank:" << " " << nevents << endl; - if (nevents > 100) { - cout << "Error! Beam off for too long" << endl; - } - - fNTrigsInBuf = 0; - // Save helcitiy and quad info for THcHelicity - for (Int_t iev = 0; iev < nevents; iev++) { // find number of helicity events in each bank - Int_t index = fNScalerChannels*iev+1; - AnalyzeHelicityScaler(p+index); - // cout << "H: " << evNumber << endl; - } - } + // This is a helicity scaler bank + if (roc == fROC) { + Int_t nevents = (banklen - 2) / fNScalerChannels; + // cout << "# of helicity events in bank:" << " " << nevents << endl; + if (nevents > 100) { + _param_logger->error("{}: Error! Beam off for too long.", here); + } + + fNTrigsInBuf = 0; + // Save helcitiy and quad info for THcHelicity + for (Int_t iev = 0; iev < nevents; iev++) { // find number of helicity events in each bank + Int_t index = fNScalerChannels * iev + 1; + AnalyzeHelicityScaler(p + index); + // cout << "H: " << evNumber << endl; + } + } } - while(p < pnext) { - Int_t nskip = 0; - if(fDebugFile) { - *fDebugFile << "Scaler Header: " << hex << *p << dec; - } - if(nskip == 0) { - if(fDebugFile) { - *fDebugFile << endl; - } - break; // Didn't find a matching header - } - p = p + nskip; + while (p < pnext) { + Int_t nskip = 0; + if (fDebugFile) { + *fDebugFile << "Scaler Header: " << hex << *p << dec; + } + if (nskip == 0) { + if (fDebugFile) { + *fDebugFile << endl; + } + break; // Didn't find a matching header + } + p = p + nskip; } p = pnext; } else { - p = p+*(p-1); // Skip to next bank + p = p + *(p - 1); // Skip to next bank } - } if (fDebugFile) { - *fDebugFile << "Finished with decoding. "<<endl; - *fDebugFile << " Found flag = "<<ifound<<endl; + *fDebugFile << "Finished with decoding. " << endl; + *fDebugFile << " Found flag = " << ifound << endl; } - if (!ifound) return 0; + if (!ifound) + return 0; return 1; - - } -Int_t THcHelicityScaler::AnalyzeHelicityScaler(UInt_t *p) -{ - Int_t hbits = (p[0]>>30) & 0x3; // quartet and helcity bits in scaler word - Bool_t isquartet = (hbits&2) != 0; - Int_t ispos = hbits&1; - Int_t actualhelicity = 0; - fHelicityHistory[fNTrigsInBuf] = hbits; +Int_t THcHelicityScaler::AnalyzeHelicityScaler(UInt_t* p) { + const static char* const here = "THcHelicityScaler::AnalyzeHelicityScaler"; + Int_t hbits = (p[0] >> 30) & 0x3; // quartet and helcity bits in scaler word + Bool_t isquartet = (hbits & 2) != 0; + Int_t ispos = hbits & 1; + Int_t actualhelicity = 0; + fHelicityHistory[fNTrigsInBuf] = hbits; fNTrigsInBuf++; fNTriggers++; - Int_t quartetphase = (fNTriggers-fFirstCycle)%4; - if(fFirstCycle >= -10) { - if(quartetphase == 0) { - Int_t predicted = RanBit30(fRingSeed_reported); - fRingSeed_reported = ((fRingSeed_reported<<1) | ispos) & 0x3FFFFFFF; + Int_t quartetphase = (fNTriggers - fFirstCycle) % 4; + if (fFirstCycle >= -10) { + if (quartetphase == 0) { + Int_t predicted = RanBit30(fRingSeed_reported); + fRingSeed_reported = ((fRingSeed_reported << 1) | ispos) & 0x3FFFFFFF; // Check if ringseed_predicted agrees with reported if(fNBits>=30) - if(fNBits >= 30 && predicted != fRingSeed_reported) { - cout << "THcHelicityScaler: Helicity Prediction Failed" << endl; - cout << "Reported " << bitset<32>(fRingSeed_reported) << endl; - cout << "Predicted " << bitset<32>(predicted) << endl; + if (fNBits >= 30 && predicted != fRingSeed_reported) { + _param_logger->warn("{}: Helicity Prediction Failed, Reported {:32b}, Predicted {:32b}", + here, fRingSeed_reported, predicted); } fNBits++; - if(fNBits==30) { - cout << "THcHelicityScaler: A " << bitset<32>(fRingSeed_reported) << - " found at cycle " << fNTriggers << endl; + if (fNBits == 30) { + _param_logger->info("{}: A {:32b} found at cycle {}", here, fRingSeed_reported, fNTriggers); } } else if (quartetphase == 3) { - if(!isquartet) { - cout << "THcHelicityScaler: Quartet bit expected but not set (" << - fNTriggers << ")" << endl; - fNBits = 0; - fRingSeed_reported = 0; - fRingSeed_actual = 0; - fFirstCycle = -100; + if (!isquartet) { + _param_logger->warn("{}: Quartet bit expected but not set ({})", here, fNTriggers); + fNBits = 0; + fRingSeed_reported = 0; + fRingSeed_actual = 0; + fFirstCycle = -100; } } - } else { // First cycle not yet identified - if(isquartet) { // Helicity and quartet signal for next set of scalers - fFirstCycle = fNTriggers - 3; - quartetphase = (fNTriggers-fFirstCycle)%4; - //// Helicity at start of quartet is same as last of quartet, so we can start filling the seed - fRingSeed_reported = ((fRingSeed_reported<<1) | ispos) & 0x3FFFFFFF; + } else { // First cycle not yet identified + if (isquartet) { // Helicity and quartet signal for next set of scalers + fFirstCycle = fNTriggers - 3; + quartetphase = (fNTriggers - fFirstCycle) % 4; + //// Helicity at start of quartet is same as last of quartet, so we can start filling the + /// seed + fRingSeed_reported = ((fRingSeed_reported << 1) | ispos) & 0x3FFFFFFF; fNBits++; - if(fNBits==30) { - cout << "THcHelicityScaler: B " << bitset<32>(fRingSeed_reported) << - " found at cycle " << fNTriggers << endl; + if (fNBits == 30) { + _param_logger->info("{}: B {:32b} fount at cycle {}", here, fRingSeed_reported, fNTriggers); } } } - if(fNBits>=30) { + if (fNBits >= 30) { fRingSeed_actual = RanBit30(fRingSeed_reported); fRingSeed_actual = RanBit30(fRingSeed_actual); #define DELAY9 #ifdef DELAY9 - if(quartetphase == 3) { + if (quartetphase == 3) { fRingSeed_actual = RanBit30(fRingSeed_actual); - actualhelicity = (fRingSeed_actual&1)?+1:-1; + actualhelicity = (fRingSeed_actual & 1) ? +1 : -1; } else { - actualhelicity = (fRingSeed_actual&1)?+1:-1; - if(quartetphase == 0 || quartetphase == 1) { - actualhelicity = -actualhelicity; + actualhelicity = (fRingSeed_actual & 1) ? +1 : -1; + if (quartetphase == 0 || quartetphase == 1) { + actualhelicity = -actualhelicity; } } #else - actualhelicity = (fRingSeed_actual&1)?+1:-1; - if(quartetphase == 1 || quartetphase == 2) { + actualhelicity = (fRingSeed_actual & 1) ? +1 : -1; + if (quartetphase == 1 || quartetphase == 2) { actualhelicity = -actualhelicity; } #endif @@ -412,119 +422,151 @@ Int_t THcHelicityScaler::AnalyzeHelicityScaler(UInt_t *p) fRingSeed_actual = 0; } - if(actualhelicity!=0) { - Int_t hindex = (actualhelicity>0)?0:1; - (actualhelicity>0)?(fNTriggersPlus++):(fNTriggersMinus++); - for(Int_t i=0;i<fNScalerChannels;i++) { - Int_t count = p[i]&0xFFFFFF; // Bottom 24 bits + if (actualhelicity != 0) { + Int_t hindex = (actualhelicity > 0) ? 0 : 1; + (actualhelicity > 0) ? (fNTriggersPlus++) : (fNTriggersMinus++); + for (Int_t i = 0; i < fNScalerChannels; i++) { + Int_t count = p[i] & 0xFFFFFF; // Bottom 24 bits fHScalers[hindex][i] += count; fScalerSums[i] += count; } } - return(0); + return (0); } + //_____________________________________________________________________________ -Int_t THcHelicityScaler::RanBit30(Int_t ranseed) -{ - - UInt_t bit7 = (ranseed & 0x00000040) != 0; - UInt_t bit28 = (ranseed & 0x08000000) != 0; - UInt_t bit29 = (ranseed & 0x10000000) != 0; - UInt_t bit30 = (ranseed & 0x20000000) != 0; +Int_t THcHelicityScaler::RanBit30(Int_t ranseed) { + + UInt_t bit7 = (ranseed & 0x00000040) != 0; + UInt_t bit28 = (ranseed & 0x08000000) != 0; + UInt_t bit29 = (ranseed & 0x10000000) != 0; + UInt_t bit30 = (ranseed & 0x20000000) != 0; UInt_t newbit = (bit30 ^ bit29 ^ bit28 ^ bit7) & 0x1; - ranseed = ( (ranseed<<1) | newbit ) & 0x3FFFFFFF; + ranseed = ((ranseed << 1) | newbit) & 0x3FFFFFFF; return ranseed; - } //_____________________________________________________________________________ -THaAnalysisObject::EStatus THcHelicityScaler::Init(const TDatime& date) -{ - +THaAnalysisObject::EStatus THcHelicityScaler::Init(const TDatime& date) { + ReadDatabase(date); fStatus = kOK; - for( vector<UInt_t*>::iterator it = fDelayedEvents.begin(); - it != fDelayedEvents.end(); ++it ) - delete [] *it; + for (vector<UInt_t*>::iterator it = fDelayedEvents.begin(); it != fDelayedEvents.end(); ++it) + delete[] * it; fDelayedEvents.clear(); - cout << "Howdy ! We are initializing THcHelicityScaler !! name = " - << fName << endl; + _param_logger->info("Howdy! We are initializing THcHelicityScaler !! name = {}", fName.Data()); - if(eventtypes.size()==0) { - eventtypes.push_back(0); // Default Event Type + if (eventtypes.size() == 0) { + eventtypes.push_back(0); // Default Event Type } - if(fROC < 0) { - fROC = 8; // Default to SHMS crate + if (fROC < 0) { + fROC = 8; // Default to SHMS crate } - fNTriggers = 0; - fNTrigsInBuf = 0; - fFirstCycle = -100; + fNTriggers = 0; + fNTrigsInBuf = 0; + fFirstCycle = -100; fRingSeed_reported = 0; - fRingSeed_actual = 0; - fNBits = 0; + fRingSeed_actual = 0; + fNBits = 0; fNTriggersPlus = fNTriggersMinus = 0; - fHScalers[0] = new Double_t[fNScalerChannels]; - fHScalers[1] = new Double_t[fNScalerChannels]; - fScalerSums = new Double_t[fNScalerChannels]; - fAsymmetry = new Double_t[fNScalerChannels]; - fAsymmetryError = new Double_t[fNScalerChannels]; - for(Int_t i=0;i<fNScalerChannels;i++) { - fHScalers[0][i] = 0.0; - fHScalers[1][i] = 0.0; - fScalerSums[0] = 0.0; - fAsymmetry[0] = 0.0; + fHScalers[0].resize(fNScalerChannels); + fHScalers[1].resize(fNScalerChannels); + fScalerSums.resize(fNScalerChannels); + fAsymmetry.resize(fNScalerChannels); + fAsymmetryError.resize(fNScalerChannels); + for (Int_t i = 0; i < fNScalerChannels; i++) { + fHScalers[0][i] = 0.0; + fHScalers[1][i] = 0.0; + fScalerSums[0] = 0.0; + fAsymmetry[0] = 0.0; fAsymmetryError[0] = 0.0; } - fCharge = new Double_t[fNumBCMs]; - fChargeAsymmetry = new Double_t[fNumBCMs]; + fCharge.resize(fNumBCMs); + fChargeAsymmetry.resize(fNumBCMs); fTime = fTimeAsymmetry = 0; - fTriggerAsymmetry = 0.0; + fTriggerAsymmetry = 0.0; MakeParms(); return kOK; } -void THcHelicityScaler::MakeParms() -{ +void THcHelicityScaler::MakeParms() { /** Put Various helicity scaler results in gHcParms so they can be included in results. */ - gHcParms->Define(Form("g%s_hscaler_plus[%d]",fName.Data(),fNScalerChannels), - "Plus Helcity Scalers",*(fHScalers[0])); - gHcParms->Define(Form("g%s_hscaler_minus[%d]",fName.Data(),fNScalerChannels), - "Minus Helcity Scalers",*(fHScalers[1])); - gHcParms->Define(Form("g%s_hscaler_sum[%d]",fName.Data(),fNScalerChannels), - "Helcity Scalers Sum",*fScalerSums); - gHcParms->Define(Form("g%s_hscaler_asy[%d]",fName.Data(),fNScalerChannels), - "Helicity Scaler Asymmetry[%d]",*fAsymmetry); - gHcParms->Define(Form("g%s_hscaler_asyerr[%d]",fName.Data(),fNScalerChannels), - "Helicity Scaler Asymmetry Error[%d]",*fAsymmetryError); - gHcParms->Define(Form("g%s_hscaler_triggers",fName.Data()), - "Total Helicity Scaler Triggers",fNTriggers); - gHcParms->Define(Form("g%s_hscaler_triggers_plus",fName.Data()), - "Positive Helicity Scaler Triggers",fNTriggersPlus); - gHcParms->Define(Form("g%s_hscaler_triggers_minus",fName.Data()), - "Negative Helicity Scaler Triggers",fNTriggersMinus); - gHcParms->Define(Form("g%s_hscaler_charge[%d]",fName.Data(),fNumBCMs), - "Helicity Gated Charge",*fCharge); - gHcParms->Define(Form("g%s_hscaler_charge_asy[%d]",fName.Data(),fNumBCMs), - "Helicity Gated Charge Asymmetry",*fChargeAsymmetry); - gHcParms->Define(Form("g%s_hscaler_time",fName.Data()), - "Helicity Gated Time (sec)",fTime); - gHcParms->Define(Form("g%s_hscaler_time_asy",fName.Data()), - "Helicity Gated Time Asymmetry",fTimeAsymmetry); - gHcParms->Define(Form("g%s_hscaler_trigger_asy",fName.Data()), - "Helicity Trigger Asymmetry",fTriggerAsymmetry); + gHcParms->Define(Form("g%s_hscaler_plus[%d]", fName.Data(), fNScalerChannels), + "Plus Helcity Scalers", fHScalers[0][0]); + gHcParms->Define(Form("g%s_hscaler_minus[%d]", fName.Data(), fNScalerChannels), + "Minus Helcity Scalers", fHScalers[1][0]); + gHcParms->Define(Form("g%s_hscaler_sum[%d]", fName.Data(), fNScalerChannels), + "Helcity Scalers Sum", fScalerSums[0]); + gHcParms->Define(Form("g%s_hscaler_asy[%d]", fName.Data(), fNScalerChannels), + "Helicity Scaler Asymmetry[%d]", fAsymmetry[0]); + gHcParms->Define(Form("g%s_hscaler_asyerr[%d]", fName.Data(), fNScalerChannels), + "Helicity Scaler Asymmetry Error[%d]", fAsymmetryError[0]); + gHcParms->Define(Form("g%s_hscaler_triggers", fName.Data()), "Total Helicity Scaler Triggers", + fNTriggers); + gHcParms->Define(Form("g%s_hscaler_triggers_plus", fName.Data()), + "Positive Helicity Scaler Triggers", fNTriggersPlus); + gHcParms->Define(Form("g%s_hscaler_triggers_minus", fName.Data()), + "Negative Helicity Scaler Triggers", fNTriggersMinus); + gHcParms->Define(Form("g%s_hscaler_charge[%d]", fName.Data(), fNumBCMs), "Helicity Gated Charge", + fCharge[0]); + gHcParms->Define(Form("g%s_hscaler_charge_asy[%d]", fName.Data(), fNumBCMs), + "Helicity Gated Charge Asymmetry", fChargeAsymmetry[0]); + gHcParms->Define(Form("g%s_hscaler_time", fName.Data()), "Helicity Gated Time (sec)", fTime); + gHcParms->Define(Form("g%s_hscaler_time_asy", fName.Data()), "Helicity Gated Time Asymmetry", + fTimeAsymmetry); + gHcParms->Define(Form("g%s_hscaler_trigger_asy", fName.Data()), "Helicity Trigger Asymmetry", + fTriggerAsymmetry); +} + +Double_t THcHelicityScaler::GetPlusCharge(const std::string& name) { + size_t i = 0; + for (; i < fNumBCMs; ++i) { + if (name == fBCM_Name[i]) { + break; + } + } + auto it = bcmindex.find(name); + + if (it != bcmindex.end() && i < fNumBCMs) { + auto index = it->second; + Double_t clock = fHScalers[0][clockindex]; + Double_t counts = fHScalers[0][index]; + return (counts - (clock / clockfreq) * fBCM_Offset[i]) / fBCM_Gain[i]; + } + _param_logger->warn("THcHelicityScaler::GetPlusCharge: Cannot find scaler {}, return 0.", name); + return 0.; +} + +Double_t THcHelicityScaler::GetMinusCharge(const std::string& name) { + size_t i = 0; + for (; i < fNumBCMs; ++i) { + if (name == fBCM_Name[i]) { + break; + } + } + auto it = bcmindex.find(name); + + if (it != bcmindex.end() && i < fNumBCMs) { + auto index = it->second; + Double_t clock = fHScalers[1][clockindex]; + Double_t counts = fHScalers[1][index]; + return (counts - (clock / clockfreq) * fBCM_Offset[i]) / fBCM_Gain[i]; + } + _param_logger->warn("THcHelicityScaler::GetMinusCharge: Cannot find scaler {}, return 0.", name); + return 0.; } ClassImp(THcHelicityScaler) diff --git a/src/THcHelicityScaler.h b/src/THcHelicityScaler.h index 8ca54718b77d7f01d9a6dc0d5b1f1932dafbe87e..650eb4bb200a9fdb6c8422998264174395043d51 100644 --- a/src/THcHelicityScaler.h +++ b/src/THcHelicityScaler.h @@ -8,94 +8,91 @@ // ///////////////////////////////////////////////////////////////////// -#include "THaEvtTypeHandler.h" #include "Decoder.h" -#include <string> -#include <vector> -#include <algorithm> -#include <set> -#include "TTree.h" +#include "THaEvtTypeHandler.h" +#include "THaRunBase.h" #include "TString.h" +#include "TTree.h" +#include "hcana/Logger.h" +#include <algorithm> #include <cstring> +#include <set> +#include <string> +#include <vector> class THcHelicity; -class THcHelicityScaler : public THaEvtTypeHandler { +class THcHelicityScaler : public hcana::ConfigLogging<THaEvtTypeHandler> { public: - THcHelicityScaler(const char*, const char*); virtual ~THcHelicityScaler(); - Int_t Analyze(THaEvData *evdata); - Int_t AnalyzeBuffer(UInt_t *rdata); - Int_t AnalyzeHelicityScaler(UInt_t *p); - - virtual EStatus Init( const TDatime& run_time); - virtual Int_t ReadDatabase(const TDatime& date ); - virtual Int_t End( THaRunBase* r=0 ); + Int_t Analyze(THaEvData* evdata); + Int_t AnalyzeBuffer(UInt_t* rdata); + Int_t AnalyzeHelicityScaler(UInt_t* p); + virtual EStatus Init(const TDatime& run_time); + virtual Int_t ReadDatabase(const TDatime& date); + virtual Int_t End(THaRunBase* r = 0); - virtual void SetUseFirstEvent(Bool_t b = kFALSE) {fUseFirstEvent = b;} + virtual void SetUseFirstEvent(Bool_t b = kFALSE) { fUseFirstEvent = b; } virtual void SetDelayedType(int evtype); - virtual void SetROC(Int_t roc) {fROC=roc;} - virtual void SetBankID(Int_t bankid) {fBankID=bankid;} - virtual void SetNScalerChannels(Int_t n) {fNScalerChannels = n;} - virtual Int_t GetNevents() { return fNTrigsInBuf;} - virtual Int_t GetNcycles() { return fNTriggers;} - virtual Int_t GetEvNum() { return evNumber;} - virtual Int_t* GetHelicityHistoryP() {return fHelicityHistory;} - virtual Int_t GetReportedSeed() {return fRingSeed_reported;} - virtual Int_t GetReportedActual() {return fRingSeed_actual;} - virtual Bool_t IsSeedGood() {return fNBits>=30;} + virtual void SetROC(Int_t roc) { fROC = roc; } + virtual void SetBankID(Int_t bankid) { fBankID = bankid; } + virtual void SetNScalerChannels(Int_t n) { fNScalerChannels = n; } + virtual Int_t GetNevents() { return fNTrigsInBuf; } + virtual Int_t GetNcycles() { return fNTriggers; } + virtual Int_t GetEvNum() { return evNumber; } + virtual Int_t* GetHelicityHistoryP() { return fHelicityHistory; } + virtual Int_t GetReportedSeed() { return fRingSeed_reported; } + virtual Int_t GetReportedActual() { return fRingSeed_actual; } + virtual Bool_t IsSeedGood() { return fNBits >= 30; } + + Double_t GetPlusCharge(const std::string& name); + Double_t GetMinusCharge(const std::string& name); private: - Int_t RanBit30(Int_t ranseed); void MakeParms(); UInt_t fBankID; // Helicity Scaler variables - Int_t fNTrigsInBuf; /* # of helicity scaler reads in last event */ + Int_t fNTrigsInBuf; /* # of helicity scaler reads in last event */ Int_t fNTriggers; Int_t fFirstCycle; Int_t fHelicityHistory[200]; // Bool_t fUseFirstEvent; - Int_t fDelayedType; + Int_t fDelayedType; Int_t fRingSeed_reported; Int_t fRingSeed_actual; Int_t fNBits; - Int_t fNTriggersPlus; - Int_t fNTriggersMinus; - Double_t* fHScalers[2]; - Int_t fGateCount[2]; - Double_t *fScalerSums; - Double_t *fAsymmetry; - Double_t *fAsymmetryError; - Double_t *fCharge; - Double_t *fChargeAsymmetry; - Double_t fTime; - Double_t fTimeAsymmetry; - Double_t fTriggerAsymmetry; + Int_t fNTriggersPlus; + Int_t fNTriggersMinus; + std::vector<Double_t> fHScalers[2]; + Int_t fGateCount[2]; + std::vector<Double_t> fScalerSums, fAsymmetry, fAsymmetryError; + std::vector<Double_t> fCharge, fChargeAsymmetry; + Double_t fTime; + Double_t fTimeAsymmetry; + Double_t fTriggerAsymmetry; std::vector<UInt_t*> fDelayedEvents; - Int_t fROC; - Int_t fNScalerChannels; // Number of scaler channels/event + Int_t fROC; + Int_t fNScalerChannels; // Number of scaler channels/event - Int_t fNumBCMs; - Double_t *fBCM_Gain; - Double_t *fBCM_Offset; - std::vector <std::string> fBCM_Name; + Int_t fNumBCMs; + std::vector<Double_t> fBCM_Gain, fBCM_Offset; + std::vector<std::string> fBCM_Name; THcHelicityScaler(const THcHelicityScaler& fh); THcHelicityScaler& operator=(const THcHelicityScaler& fh); UInt_t evNumber; - ClassDef(THcHelicityScaler,0) // Scaler Event handler - + ClassDef(THcHelicityScaler, 0) // Scaler Event handler }; #endif diff --git a/src/THcHitList.cxx b/src/THcHitList.cxx index b835169c55424c087867070e6de8f25746790bd6..c06589fc59a34dd39d0a8cdf581912b4ae2c8fb8 100644 --- a/src/THcHitList.cxx +++ b/src/THcHitList.cxx @@ -21,8 +21,9 @@ using namespace std; #define SUPPRESSMISSINGADCREFTIMEMESSAGES 1 -THcHitList::THcHitList() : fMap(0), fTISlot(0), fDisableSlipCorrection(kFALSE) +THcHitList::THcHitList() : podd2::HitLogging<podd2::EmptyBase>(), fMap(0), fTISlot(0), fDisableSlipCorrection(kFALSE) { + /// Normal constructor. fRawHitList = NULL; @@ -59,8 +60,10 @@ a method to ask the OO decoder what kind of module is in a given slot? void THcHitList::InitHitList(THaDetMap* detmap, const char *hitclass, Int_t maxhits, - Int_t tdcref_cut, Int_t adcref_cut) { - cout << "InitHitList: " << hitclass << " RefTimeCuts: " << tdcref_cut << " " << adcref_cut << endl; + Int_t tdcref_cut, Int_t adcref_cut) { + _hit_logger->set_level(spdlog::level::debug); + _hit_logger->info("InitHitList: {} RefTimeCuts: {} {}", hitclass, tdcref_cut, adcref_cut); + //cout << "InitHitList: " << hitclass << " RefTimeCuts: " << tdcref_cut << " " << adcref_cut << endl; fRawHitList = new TClonesArray(hitclass, maxhits); fRawHitClass = fRawHitList->GetClass(); fNMaxRawHits = maxhits; @@ -187,7 +190,7 @@ Int_t THcHitList::DecodeToHitList( const THaEvData& evdata, Bool_t suppresswarni if(!fMap) { // Find the TI slot for ADCs // Assumes that all FADCs are in the same crate - cout << "Got the Crate map" << endl; + //cout << "Got the Crate map" << endl; fMap = evdata.GetCrateMap(); for (Int_t i=0; i < fdMap->GetSize(); i++) { // Look for a FADC250 THaDetMap::Module* d = fdMap->GetModule(i); @@ -198,7 +201,7 @@ Int_t THcHitList::DecodeToHitList( const THaEvData& evdata, Bool_t suppresswarni if(fMap->getModel(d->crate, slot) == 4) { fTISlot = slot; fTICrate = d->crate; - cout << "TI Slot = " << fTISlot << endl; + //cout << "TI Slot = " << fTISlot << endl; break; } } @@ -234,7 +237,8 @@ Int_t THcHitList::DecodeToHitList( const THaEvData& evdata, Bool_t suppresswarni Bool_t tdcref_miss = kFALSE; Bool_t adcref_miss = kFALSE; - // Get the indexed reference times for this event + // + /// Get the indexed reference times for this event for(Int_t i=0;i<fNRefIndex;i++) { if(fRefIndexMaps[i].defined) { @@ -306,6 +310,8 @@ Int_t THcHitList::DecodeToHitList( const THaEvData& evdata, Bool_t suppresswarni } } } + + // for ( Int_t i=0; i < fdMap->GetSize(); i++ ) { THaDetMap::Module* d = fdMap->GetModule(i); @@ -404,16 +410,22 @@ Int_t THcHitList::DecodeToHitList( const THaEvData& evdata, Bool_t suppresswarni } } } - } else { // This is a Flash ADC + } else { + // This is a Flash ADC if (fPSE125) { if(!fHaveFADCInfo) { - fNSA = fPSE125->GetNSA(d->crate); - fNSB = fPSE125->GetNSB(d->crate); - fNPED = fPSE125->GetNPED(d->crate); + //fNSA = fPSE125->GetNSA(d->crate); + //fNSB = fPSE125->GetNSB(d->crate); + //fNPED = fPSE125->GetNPED(d->crate); + // Hard coding for now so we don't need event typ 125 at the start of run. + fNSA = 26; + fNSB = 3; + fNPED = 4; fHaveFADCInfo = kTRUE; - } - // Set F250 parameters. + } + //std::cout << fNSA << ", " << fNSB << ", " << fNPED << "\n"; + // Set F250 parameters. rawhit->SetF250Params(fNSA, fNSB, fNPED); } @@ -427,8 +439,9 @@ Int_t THcHitList::DecodeToHitList( const THaEvData& evdata, Bool_t suppresswarni } // Now get the pulse mode data // Pulse area will go into regular SetData, others will use special hit methods - Int_t npulses=evdata.GetNumEvents(Decoder::kPulseIntegral, d->crate, d->slot, chan); - // Assume that the # of pulses for kPulseTime, kPulsePeak and kPulsePedestal are same; + Int_t npulses = evdata.GetNumEvents(Decoder::kPulseIntegral, d->crate, d->slot, chan); + + // Assume that the # of pulses for kPulseTime, kPulsePeak and kPulsePedestal are same; Int_t timeshift=0; if(fTISlot>0) { // Get the trigger time for this module if(fTrigTimeShiftMap.find(d->slot) @@ -441,6 +454,7 @@ Int_t THcHitList::DecodeToHitList( const THaEvData& evdata, Bool_t suppresswarni timeshift = fTrigTimeShiftMap[d->slot]; } for (Int_t ipulse=0;ipulse<npulses;ipulse++) { + //_hit_logger->debug("event {} : ROC {} slot {} channel {}", evdata.GetEvNum() , d->crate, d->slot, chan); rawhit->SetDataTimePedestalPeak(signal, evdata.GetData(Decoder::kPulseIntegral, d->crate, d->slot, chan, ipulse), evdata.GetData(Decoder::kPulseTime, d->crate, d->slot, chan, ipulse)+64*timeshift, @@ -518,8 +532,11 @@ Int_t THcHitList::DecodeToHitList( const THaEvData& evdata, Bool_t suppresswarni map<Int_t, Int_t>::iterator it; for(it=fTrigTimeShiftMap.begin(); it!=fTrigTimeShiftMap.end(); it++) { if(it->second < -3 || it->second > 3) { - cout << "Big ADC Trigger Time Shift, ROC " << fTICrate << endl; - cout << it->first << " " << it->second << endl; + + _hit_logger->warn("Big ADC Trigger Time Shift, ROC {}", fTICrate); + _hit_logger->warn(" {} {}", it->first, it->second); + //cout << "Big ADC Trigger Time Shift, ROC " << fTICrate << endl; + //cout << it->first << " " << it->second << endl; } } } @@ -539,13 +556,22 @@ void THcHitList::CreateMissReportParms(const char *prefix) Parameters created are ${prefix}_tdcref_miss and ${prefix}_adcref_miss */ - cout << "Defining " << Form("%s_tdcref_miss", prefix) << " and " << Form("%s_adcref_miss", prefix) << endl; + _hit_logger->info("Defining {}_tdcref_miss and {}_adcref_miss", prefix, prefix); + //cout << "Defining " << Form("%s_tdcref_miss", prefix) << " and " << Form("%s_adcref_miss", prefix) << endl; gHcParms->Define(Form("%s_tdcref_miss", prefix), "Missing TDC reference times", fNTDCRef_miss); gHcParms->Define(Form("%s_adcref_miss", prefix), "Missing ADC reference times", fNADCRef_miss); } void THcHitList::MissReport(const char *name) { - cout << "Missing Ref times:" << setw(20) << name << setw(10) << fNTDCRef_miss << setw(10) << fNADCRef_miss << endl; + + _hit_logger->warn("Missing Ref times: {:20} {:10} {:10}", name, fNTDCRef_miss, fNADCRef_miss); + if( fNTDCRef_miss != 0) { + _hit_logger->error("Missing Ref times: {:20} {:10} {:10}", name, fNTDCRef_miss, fNADCRef_miss); + } + if( fNADCRef_miss != 0) { + _hit_logger->error("Missing Ref times: {:20} {:10} {:10}", name, fNTDCRef_miss, fNADCRef_miss); + } + //cout << "Missing Ref times:" << setw(20) << name << setw(10) << fNTDCRef_miss << setw(10) << fNADCRef_miss << endl; } ClassImp(THcHitList) diff --git a/src/THcHitList.h b/src/THcHitList.h index 568d089694f00dde79e79f4ca3e211353e0b30c1..a8db5bca6af2fcf3db369c39f75e53d0de427b5d 100644 --- a/src/THcHitList.h +++ b/src/THcHitList.h @@ -13,6 +13,8 @@ #include <iomanip> #include <map> +#include "hcana/Logger.h" + using namespace std; ////////////////////////////////////////////////////////////////////////// @@ -24,7 +26,7 @@ using namespace std; //class THaDetMap; class THcConfigEvtHandler; -class THcHitList { +class THcHitList : public podd2::HitLogging<podd2::EmptyBase> { public: @@ -32,6 +34,13 @@ public: THcHitList(); + /** Populate the hitlist from the raw event data. + * Clears the hit list then, finds all populated channels belonging to the detector and add + * sort it into the hitlist. A given counter in the detector can have + * at most one entry in the hit list. However, the raw "hit" can contain + * multiple signal types (e.g. ADC+, ADC-, TDC+, TDC-), or multiplehits for multihit tdcs. + * The hit list is sorted (by plane, counter) after filling. + */ virtual Int_t DecodeToHitList( const THaEvData& evdata, Bool_t suppress=kFALSE ); void InitHitList(THaDetMap* detmap, const char *hitclass, Int_t maxhits, @@ -42,17 +51,19 @@ public: void MissReport(const char *name); void DisableSlipCorrection() {fDisableSlipCorrection = kTRUE;} - UInt_t fNRawHits; + UInt_t fNRawHits; Int_t fNMaxRawHits; Int_t fTDC_RefTimeCut; Int_t fADC_RefTimeCut; Bool_t fTDC_RefTimeBest; Bool_t fADC_RefTimeBest; - TClonesArray* fRawHitList; // List of raw hits - TClass* fRawHitClass; // Class of raw hit object to use - + TClonesArray* fRawHitList; // List of raw hits + TClass* fRawHitClass; // Class of raw hit object to use THaDetMap* fdMap; + Int_t fNTDCRef_miss; + Int_t fNADCRef_miss; + protected: struct RefIndexMap { // Mapping for one reference channel @@ -68,24 +79,21 @@ protected: // Should this be a sparse list instead in case user // picks ridiculously large refindexes? - Int_t fNRefIndex; - UInt_t fNSignals; - THcRawHit::ESignalType *fSignalTypes; - - THcConfigEvtHandler* fPSE125; - Bool_t fHaveFADCInfo; - Int_t fNSA; - Int_t fNSB; - Int_t fNPED; - - Int_t fNTDCRef_miss; - Int_t fNADCRef_miss; - - Decoder::THaCrateMap* fMap; /* The Crate map */ - Int_t fTISlot; - Int_t fTICrate; - Double_t fDisableSlipCorrection; - std::map<Int_t, Int_t> fTrigTimeShiftMap; + Int_t fNRefIndex; + UInt_t fNSignals; + THcRawHit::ESignalType* fSignalTypes; + THcConfigEvtHandler* fPSE125; + Bool_t fHaveFADCInfo; + Int_t fNSA; + Int_t fNSB; + Int_t fNPED; + + + Decoder::THaCrateMap* fMap; /* The Crate map */ + Int_t fTISlot; + Int_t fTICrate; + Double_t fDisableSlipCorrection; + std::map<Int_t, Int_t> fTrigTimeShiftMap; std::map<Int_t, Decoder::Fadc250Module*> fFADCSlotMap; ClassDef(THcHitList,0); // List of raw hits sorted by plane, counter diff --git a/src/THcHodoEff.cxx b/src/THcHodoEff.cxx index d40453b415e914829153ef15aa2ded6a5aa932ca..941b89f85915dc4c6c9e535a71c34765baec1d6e 100644 --- a/src/THcHodoEff.cxx +++ b/src/THcHodoEff.cxx @@ -26,7 +26,7 @@ using namespace std; //_____________________________________________________________________________ THcHodoEff::THcHodoEff (const char *name, const char* description, const char* hodname) : - THaPhysicsModule(name, description), fName(hodname), fHod(NULL), fNevt(0) + hcana::ConfigLogging<THaPhysicsModule>(name, description), fName(hodname), fHod(NULL), fNevt(0) { } @@ -146,10 +146,12 @@ THaAnalysisObject::EStatus THcHodoEff::Init( const TDatime& run_time ) if( THaPhysicsModule::Init( run_time ) != kOK ) return fStatus; - cout << "THcHodoEff::Init nplanes=" << fHod->GetNPlanes() << endl; - cout << "THcHodoEff::Init Apparatus = " << fHod->GetName() << - " " << - (fHod->GetApparatus())->GetName() << endl; + //cout << "THcHodoEff::Init nplanes=" << fHod->GetNPlanes() << endl; + //cout << "THcHodoEff::Init Apparatus = " << fHod->GetName() << + // " " << + // (fHod->GetApparatus())->GetName() << endl; + _logger->info("THcHodoEff::Init nplanes={}", fHod->GetNPlanes()); + _logger->info("THcHodoEff::Init Apparatus = {} {}", fHod->GetName(), (fHod->GetApparatus())->GetName()); return fStatus = kOK; } @@ -203,7 +205,8 @@ Int_t THcHodoEff::ReadDatabase( const TDatime& date ) }; fHodoEff_CalEnergy_Cut=0.050; // set default value gHcParms->LoadParmValues((DBRequest*)&list,prefix); - cout << "\n\nTHcHodoEff::ReadDatabase nplanes=" << fHod->GetNPlanes() << endl; + //cout << "\n\nTHcHodoEff::ReadDatabase nplanes=" << fHod->GetNPlanes() << endl; + _logger->info("THcHodoEff::ReadDatabase nplanes={}", fHod->GetNPlanes()); // Setup statistics arrays // Better method to put this in? // These all need to be cleared in Begin @@ -220,7 +223,8 @@ Int_t THcHodoEff::ReadDatabase( const TDatime& date ) for(Int_t ip=0;ip<fNPlanes;ip++) { - cout << "Plane = " << ip + 1 << " counters = " << fNCounters[ip] << endl; + //cout << "Plane = " << ip + 1 << " counters = " << fNCounters[ip] << endl; + _logger->info("Plane = {} counters = {} ", ip + 1, fNCounters[ip]); fStatTrkDel[ip].resize(fNCounters[ip]); fStatAndHitDel[ip].resize(fNCounters[ip]); diff --git a/src/THcHodoEff.h b/src/THcHodoEff.h index d2369c06389bcbac8f30898481e30b6bc85c8224..127d9294dbb8e3b109a7d28d3bf581ee3f1b95b7 100644 --- a/src/THcHodoEff.h +++ b/src/THcHodoEff.h @@ -23,7 +23,9 @@ #include "THaSpectrometer.h" #include "THaTrack.h" -class THcHodoEff : public THaPhysicsModule { +#include "hcana/Logger.h" + +class THcHodoEff : public hcana::ConfigLogging<THaPhysicsModule> { public: THcHodoEff( const char* name, const char* description, const char* hodname); virtual ~THcHodoEff(); diff --git a/src/THcHodoscope.cxx b/src/THcHodoscope.cxx index 8edfc197c1d87afef8884d7847b5220770ffcdb5..86441a263edac2821fad1c2aaa7dc69aed4dc84e 100644 --- a/src/THcHodoscope.cxx +++ b/src/THcHodoscope.cxx @@ -9,137 +9,140 @@ hodoscope array, not just one plane. */ -#include "THcSignalHit.h" -#include "THcScintPlaneCluster.h" -#include "THcShower.h" +#include "TClass.h" +#include "THaSubDetector.h" #include "THcCherenkov.h" #include "THcHallCSpectrometer.h" #include "THcHitList.h" #include "THcRawShowerHit.h" -#include "TClass.h" +#include "THcScintPlaneCluster.h" +#include "THcShower.h" +#include "THcSignalHit.h" #include "math.h" -#include "THaSubDetector.h" -#include "THcHodoscope.h" -#include "THaEvData.h" +#include "TClonesArray.h" +#include "THaCutList.h" #include "THaDetMap.h" -#include "THcDetectorMap.h" +#include "THaEvData.h" #include "THaGlobals.h" -#include "THaCutList.h" +#include "THaTrack.h" +#include "THcDetectorMap.h" #include "THcGlobals.h" +#include "THcHodoscope.h" #include "THcParmList.h" +#include "TMath.h" #include "VarDef.h" #include "VarType.h" -#include "THaTrack.h" -#include "TClonesArray.h" -#include "TMath.h" + +#include "THaOutput.h" +#include "TTree.h" #include "THaTrackProj.h" #include <vector> -#include <cstring> +#include <algorithm> +#include <array> #include <cstdio> #include <cstdlib> -#include <iostream> -#include <iomanip> +#include <cstring> #include <fstream> +#include <iomanip> +#include <iostream> + +#include "hcana/helpers.hxx" #include <cassert> using namespace std; using std::vector; //_____________________________________________________________________________ -THcHodoscope::THcHodoscope( const char* name, const char* description, - THaApparatus* apparatus ) : - THaNonTrackingDetector(name,description,apparatus) -{ +THcHodoscope::THcHodoscope(const char* name, const char* description, THaApparatus* apparatus) + : hcana::ConfigLogging<THaNonTrackingDetector>(name, description, apparatus) { // Constructor - //fTrackProj = new TClonesArray( "THaTrackProj", 5 ); + // fTrackProj = new TClonesArray( "THaTrackProj", 5 ); // Construct the planes - fNPlanes = 0; // No planes until we make them - fStartTime=-1e5; - fGoodStartTime=kFALSE; + fNPlanes = 0; // No planes until we make them + fStartTime = -1e5; + fGoodStartTime = kFALSE; } //_____________________________________________________________________________ -THcHodoscope::THcHodoscope( ) : - THaNonTrackingDetector() -{ +THcHodoscope::THcHodoscope() : hcana::ConfigLogging<THaNonTrackingDetector>() { // Constructor } //_____________________________________________________________________________ -void THcHodoscope::Setup(const char* name, const char* description) -{ +void THcHodoscope::Setup(const char* name, const char* description) { /** Create the scintillator plane objects for the hodoscope. - + Uses the Xhodo_num_planes and Xhodo_plane_names to get the number of planes and their names. Gets a pointer to the Cherenkov named "cer" ("hgcer" in the case of the SHMS.) - */ - if( IsZombie()) return; + */ + if (IsZombie()) + return; // fDebug = 1; // Keep this at one while we're working on the code char prefix[2]; - prefix[0]=tolower(GetApparatus()->GetName()[0]); - prefix[1]='\0'; + prefix[0] = tolower(GetApparatus()->GetName()[0]); + prefix[1] = '\0'; TString temp(prefix[0]); - fSHMS=kFALSE; - if (temp == "p" ) fSHMS=kTRUE; - TString histname=temp+"_timehist"; - hTime = new TH1F(histname,"",400,0,200); + fSHMS = kFALSE; + if (temp == "p") + fSHMS = kTRUE; + TString histname = temp + "_timehist"; + hTime = new TH1F(histname, "", 400, 0, 200); // cout << " fSHMS = " << fSHMS << endl; - string planenamelist; - DBRequest listextra[]={ - {"hodo_num_planes", &fNPlanes, kInt}, - {"hodo_plane_names",&planenamelist, kString}, - {"hodo_tdcrefcut", &fTDC_RefTimeCut, kInt, 0, 1}, - {"hodo_adcrefcut", &fADC_RefTimeCut, kInt, 0, 1}, - {0} - }; - //fNPlanes = 4; // Default if not defined - fTDC_RefTimeCut = 0; // Minimum allowed reference times + string planenamelist; + DBRequest listextra[] = {{"hodo_num_planes", &fNPlanes, kInt}, + {"hodo_plane_names", &planenamelist, kString}, + {"hodo_tdcrefcut", &fTDC_RefTimeCut, kInt, 0, 1}, + {"hodo_adcrefcut", &fADC_RefTimeCut, kInt, 0, 1}, + {0}}; + // fNPlanes = 4; // Default if not defined + fTDC_RefTimeCut = 0; // Minimum allowed reference times fADC_RefTimeCut = 0; - gHcParms->LoadParmValues((DBRequest*)&listextra,prefix); + gHcParms->LoadParmValues((DBRequest*)&listextra, prefix); - cout << "Plane Name List : " << planenamelist << endl; + _det_logger->info("Plane Name List : {}", planenamelist); + // cout << "Plane Name List : " << planenamelist << endl; vector<string> plane_names = vsplit(planenamelist); // Plane names - if(plane_names.size() != (UInt_t) fNPlanes) { - cout << "ERROR: Number of planes " << fNPlanes << " doesn't agree with number of plane names " << plane_names.size() << endl; + if (plane_names.size() != (UInt_t)fNPlanes) { + cout << "ERROR: Number of planes " << fNPlanes << " doesn't agree with number of plane names " + << plane_names.size() << endl; // Should quit. Is there an official way to quit? } - fPlaneNames = new char* [fNPlanes]; - for(Int_t i=0;i<fNPlanes;i++) { - fPlaneNames[i] = new char[plane_names[i].length()+1]; + fPlaneNames = new char*[fNPlanes]; + for (Int_t i = 0; i < fNPlanes; i++) { + fPlaneNames[i] = new char[plane_names[i].length() + 1]; strcpy(fPlaneNames[i], plane_names[i].c_str()); } // Probably shouldn't assume that description is defined - char* desc = new char[strlen(description)+100]; - fPlanes = new THcScintillatorPlane* [fNPlanes]; - for(Int_t i=0;i < fNPlanes;i++) { + char* desc = new char[strlen(description) + 100]; + fPlanes = new THcScintillatorPlane*[fNPlanes]; + for (Int_t i = 0; i < fNPlanes; i++) { strcpy(desc, description); strcat(desc, " Plane "); strcat(desc, fPlaneNames[i]); - fPlanes[i] = new THcScintillatorPlane(fPlaneNames[i], desc, i+1, this); // Number planes starting from zero!! - cout << "Created Scintillator Plane " << fPlaneNames[i] << ", " << desc << endl; + fPlanes[i] = new THcScintillatorPlane(fPlaneNames[i], desc, i + 1, + this); // Number planes starting from zero!! + // cout << "Created Scintillator Plane " << fPlaneNames[i] << ", " << desc << endl; } // Save the nominal particle mass - THcHallCSpectrometer *app = dynamic_cast<THcHallCSpectrometer*>(GetApparatus()); - fPartMass = app->GetParticleMass(); - fBetaNominal = app->GetBetaAtPcentral(); - - + THcHallCSpectrometer* app = dynamic_cast<THcHallCSpectrometer*>(GetApparatus()); + fPartMass = app->GetParticleMass(); + fBetaNominal = app->GetBetaAtPcentral(); if (fSHMS) { fCherenkov = dynamic_cast<THcCherenkov*>(app->GetDetector("hgcer")); @@ -147,20 +150,20 @@ void THcHodoscope::Setup(const char* name, const char* description) fCherenkov = dynamic_cast<THcCherenkov*>(app->GetDetector("cer")); } - delete [] desc; + delete[] desc; } //_____________________________________________________________________________ -THaAnalysisObject::EStatus THcHodoscope::Init( const TDatime& date ) -{ +THaAnalysisObject::EStatus THcHodoscope::Init(const TDatime& date) { // cout << "In THcHodoscope::Init()" << endl; Setup(GetName(), GetTitle()); char EngineDID[] = "xSCIN"; - EngineDID[0] = toupper(GetApparatus()->GetName()[0]); - if( gHcDetectorMap->FillMap(fDetMap, EngineDID) < 0 ) { + EngineDID[0] = toupper(GetApparatus()->GetName()[0]); + if (gHcDetectorMap->FillMap(fDetMap, EngineDID) < 0) { static const char* const here = "Init()"; - Error( Here(here), "Error filling detectormap for %s.", EngineDID ); + // Error( Here(here), "Error filling detectormap for %s.", EngineDID ); + _det_logger->error("THcHodoscope::Init : Error filling detectormap for {}.", EngineDID); return kInitError; } @@ -168,26 +171,28 @@ THaAnalysisObject::EStatus THcHodoscope::Init( const TDatime& date ) // maximum number of hits after setting up the detector map // But it needs to happen before the sub detectors are initialized // so that they can get the pointer to the hitlist. - cout << " Hodo tdc ref time cut = " << fTDC_RefTimeCut << " " << fADC_RefTimeCut << endl; + _det_logger->info("Hodo TDC and ADC ref time cut = {} {}", fTDC_RefTimeCut, fADC_RefTimeCut); + // cout << " Hodo tdc ref time cut = " << fTDC_RefTimeCut << " " << fADC_RefTimeCut << endl; - InitHitList(fDetMap, "THcRawHodoHit", fDetMap->GetTotNumChan()+1, - fTDC_RefTimeCut, fADC_RefTimeCut); + InitHitList(fDetMap, "THcRawHodoHit", fDetMap->GetTotNumChan() + 1, fTDC_RefTimeCut, + fADC_RefTimeCut); EStatus status; // This triggers call of ReadDatabase and DefineVariables - if( (status = THaNonTrackingDetector::Init( date )) ) - return fStatus=status; + if ((status = THaNonTrackingDetector::Init(date))) + return fStatus = status; - for(Int_t ip=0;ip<fNPlanes;ip++) { - if((status = fPlanes[ip]->Init( date ))) { - return fStatus=status; + for (Int_t ip = 0; ip < fNPlanes; ip++) { + if ((status = fPlanes[ip]->Init(date))) { + return fStatus = status; } } - fNScinHits = new Int_t [fNPlanes]; - fGoodPlaneTime = new Bool_t [fNPlanes]; - fNPlaneTime = new Int_t [fNPlanes]; - fSumPlaneTime = new Double_t [fNPlanes]; + // Why not std::vector? + fNScinHits = new Int_t[fNPlanes]; + fGoodPlaneTime = new Bool_t[fNPlanes]; + fNPlaneTime = new Int_t[fNPlanes]; + fSumPlaneTime = new Double_t[fNPlanes]; // Double_t fHitCnt4 = 0., fHitCnt3 = 0.; @@ -197,21 +202,20 @@ THaAnalysisObject::EStatus THcHodoscope::Init( const TDatime& date ) // fScinHit[m] = new Double_t[fNPaddle[0]]; // } - for (int ip=0; ip<fNPlanes; ++ip) { + for (int ip = 0; ip < fNPlanes; ++ip) { fScinHitPaddle.push_back(std::vector<Int_t>(fNPaddle[ip], 0)); } - fPresentP = 0; - THaVar* vpresent = gHaVars->Find(Form("%s.present",GetApparatus()->GetName())); - if(vpresent) { - fPresentP = (Bool_t *) vpresent->GetValuePointer(); + fPresentP = 0; + THaVar* vpresent = gHaVars->Find(Form("%s.present", GetApparatus()->GetName())); + if (vpresent) { + fPresentP = (Bool_t*)vpresent->GetValuePointer(); } return fStatus = kOK; } //_____________________________________________________________________________ -Int_t THcHodoscope::ReadDatabase( const TDatime& date ) -{ +Int_t THcHodoscope::ReadDatabase(const TDatime& date) { /** Read this detector's parameters from the ThcParmlist. @@ -225,100 +229,99 @@ Int_t THcHodoscope::ReadDatabase( const TDatime& date ) // Determine which spectrometer in order to construct // the parameter names (e.g. hscin_1x_nr vs. sscin_1x_nr) - prefix[0]=tolower(GetApparatus()->GetName()[0]); - // - prefix[1]='\0'; - strcpy(parname,prefix); - strcat(parname,"scin_"); - // + prefix[0] = tolower(GetApparatus()->GetName()[0]); // + prefix[1] = '\0'; + strcpy(parname, prefix); + strcat(parname, "scin_"); // Int_t plen=strlen(parname); // cout << " readdatabse hodo fnplanes = " << fNPlanes << endl; - CreateMissReportParms(Form("%sscin",prefix)); + CreateMissReportParms(Form("%sscin", prefix)); - fBetaNoTrk = 0.; + fBetaNoTrk = 0.; fBetaNoTrkChiSq = 0.; + fNPaddle = new UInt_t [fNPlanes]; fFPTime = new Double_t [fNPlanes]; fPlaneCenter = new Double_t[fNPlanes]; + fPlaneSpacing = new Double_t[fNPlanes]; - prefix[0]=tolower(GetApparatus()->GetName()[0]); + prefix[0] = tolower(GetApparatus()->GetName()[0]); // - prefix[1]='\0'; + prefix[1] = '\0'; - for(Int_t i=0;i<fNPlanes;i++) { - - DBRequest list[]={ - {Form("scin_%s_nr",fPlaneNames[i]), &fNPaddle[i], kInt}, - {0} - }; + for (Int_t i = 0; i < fNPlanes; i++) { + DBRequest list[] = {{Form("scin_%s_nr", fPlaneNames[i]), &fNPaddle[i], kInt}, {0}}; - gHcParms->LoadParmValues((DBRequest*)&list,prefix); + gHcParms->LoadParmValues((DBRequest*)&list, prefix); } // GN added // reading variables from *hodo.param + fMaxScinPerPlane=fNPaddle[0]; fTotHodScin=fNPaddle[0]; for (Int_t i=1;i<fNPlanes;i++) { fMaxScinPerPlane=(fMaxScinPerPlane > fNPaddle[i])? fMaxScinPerPlane : fNPaddle[i]; fTotHodScin+=(fNPaddle[i]); + } // need this for "padded arrays" i.e. 4x16 lists of parameters (GN) - fMaxHodoScin=fMaxScinPerPlane*fNPlanes; - if (fDebug>=1) cout <<"fMaxScinPerPlane = "<<fMaxScinPerPlane<<" fMaxHodoScin = "<<fMaxHodoScin<<endl; - - fHodoVelLight=new Double_t [fMaxHodoScin]; - fHodoPosSigma=new Double_t [fMaxHodoScin]; - fHodoNegSigma=new Double_t [fMaxHodoScin]; - fHodoPosMinPh=new Double_t [fMaxHodoScin]; - fHodoNegMinPh=new Double_t [fMaxHodoScin]; - fHodoPosPhcCoeff=new Double_t [fMaxHodoScin]; - fHodoNegPhcCoeff=new Double_t [fMaxHodoScin]; - fHodoPosTimeOffset=new Double_t [fMaxHodoScin]; - fHodoNegTimeOffset=new Double_t [fMaxHodoScin]; - fHodoPosPedLimit=new Int_t [fMaxHodoScin]; - fHodoNegPedLimit=new Int_t [fMaxHodoScin]; - fHodoPosInvAdcOffset=new Double_t [fMaxHodoScin]; - fHodoNegInvAdcOffset=new Double_t [fMaxHodoScin]; - fHodoPosInvAdcLinear=new Double_t [fMaxHodoScin]; - fHodoNegInvAdcLinear=new Double_t [fMaxHodoScin]; - fHodoPosInvAdcAdc=new Double_t [fMaxHodoScin]; - fHodoNegInvAdcAdc=new Double_t [fMaxHodoScin]; - - //New Time-Walk Calibration Parameters - fHodoVelFit=new Double_t [fMaxHodoScin]; - fHodoCableFit=new Double_t [fMaxHodoScin]; - fHodo_LCoeff=new Double_t [fMaxHodoScin]; - fHodoPos_c1=new Double_t [fMaxHodoScin]; - fHodoNeg_c1=new Double_t [fMaxHodoScin]; - fHodoPos_c2=new Double_t [fMaxHodoScin]; - fHodoNeg_c2=new Double_t [fMaxHodoScin]; - fHodoSigmaPos=new Double_t [fMaxHodoScin]; - fHodoSigmaNeg=new Double_t [fMaxHodoScin]; - - fNHodoscopes = 2; - fxLoScin = new Int_t [fNHodoscopes]; - fxHiScin = new Int_t [fNHodoscopes]; - fyLoScin = new Int_t [fNHodoscopes]; - fyHiScin = new Int_t [fNHodoscopes]; - fHodoSlop = new Double_t [fNPlanes]; - fTdcOffset = new Int_t [fNPlanes]; - fAdcTdcOffset = new Double_t [fNPlanes]; - fHodoPosAdcTimeWindowMin = new Double_t [fMaxHodoScin]; - fHodoPosAdcTimeWindowMax = new Double_t [fMaxHodoScin]; - fHodoNegAdcTimeWindowMin = new Double_t [fMaxHodoScin]; - fHodoNegAdcTimeWindowMax = new Double_t [fMaxHodoScin]; - - - for(Int_t ip=0;ip<fNPlanes;ip++) { // Set a large default window - fTdcOffset[ip] = 0 ; - fAdcTdcOffset[ip] = 0.0 ; + fMaxHodoScin = fMaxScinPerPlane * fNPlanes; + if (fDebug >= 1) + cout << "fMaxScinPerPlane = " << fMaxScinPerPlane << " fMaxHodoScin = " << fMaxHodoScin << endl; + + fHodoVelLight = new Double_t[fMaxHodoScin]; + fHodoPosSigma = new Double_t[fMaxHodoScin]; + fHodoNegSigma = new Double_t[fMaxHodoScin]; + fHodoPosMinPh = new Double_t[fMaxHodoScin]; + fHodoNegMinPh = new Double_t[fMaxHodoScin]; + fHodoPosPhcCoeff = new Double_t[fMaxHodoScin]; + fHodoNegPhcCoeff = new Double_t[fMaxHodoScin]; + fHodoPosTimeOffset = new Double_t[fMaxHodoScin]; + fHodoNegTimeOffset = new Double_t[fMaxHodoScin]; + fHodoPosPedLimit = new Int_t[fMaxHodoScin]; + fHodoNegPedLimit = new Int_t[fMaxHodoScin]; + fHodoPosInvAdcOffset = new Double_t[fMaxHodoScin]; + fHodoNegInvAdcOffset = new Double_t[fMaxHodoScin]; + fHodoPosInvAdcLinear = new Double_t[fMaxHodoScin]; + fHodoNegInvAdcLinear = new Double_t[fMaxHodoScin]; + fHodoPosInvAdcAdc = new Double_t[fMaxHodoScin]; + fHodoNegInvAdcAdc = new Double_t[fMaxHodoScin]; + + // New Time-Walk Calibration Parameters + fHodoVelFit = new Double_t[fMaxHodoScin]; + fHodoCableFit = new Double_t[fMaxHodoScin]; + fHodo_LCoeff = new Double_t[fMaxHodoScin]; + fHodoPos_c1 = new Double_t[fMaxHodoScin]; + fHodoNeg_c1 = new Double_t[fMaxHodoScin]; + fHodoPos_c2 = new Double_t[fMaxHodoScin]; + fHodoNeg_c2 = new Double_t[fMaxHodoScin]; + fHodoSigmaPos = new Double_t[fMaxHodoScin]; + fHodoSigmaNeg = new Double_t[fMaxHodoScin]; + + fNHodoscopes = 2; + fxLoScin = new Int_t[fNHodoscopes]; + fxHiScin = new Int_t[fNHodoscopes]; + fyLoScin = new Int_t[fNHodoscopes]; + fyHiScin = new Int_t[fNHodoscopes]; + fHodoSlop = new Double_t[fNPlanes]; + fTdcOffset = new Int_t[fNPlanes]; + fAdcTdcOffset = new Double_t[fNPlanes]; + fHodoPosAdcTimeWindowMin = new Double_t[fMaxHodoScin]; + fHodoPosAdcTimeWindowMax = new Double_t[fMaxHodoScin]; + fHodoNegAdcTimeWindowMin = new Double_t[fMaxHodoScin]; + fHodoNegAdcTimeWindowMax = new Double_t[fMaxHodoScin]; + + for (Int_t ip = 0; ip < fNPlanes; ip++) { // Set a large default window + fTdcOffset[ip] = 0; + fAdcTdcOffset[ip] = 0.0; } + DBRequest list[]={ {"cosmicflag", &fCosmicFlag, kInt, 0, 1}, {"NumPlanesBetaCalc", &fNumPlanesBetaCalc, kInt, 0, 1}, @@ -367,6 +370,7 @@ Int_t THcHodoscope::ReadDatabase( const TDatime& date ) trackeff_scint_ydiff_max=20.; trackeff_scint_xdiff_max=20.; for(UInt_t ip=0;ip<fMaxHodoScin;ip++) { + fHodoPosAdcTimeWindowMin[ip] = -1000.; fHodoPosAdcTimeWindowMax[ip] = 1000.; fHodoNegAdcTimeWindowMin[ip] = -1000.; @@ -374,33 +378,34 @@ Int_t THcHodoscope::ReadDatabase( const TDatime& date ) fHodoPosPedLimit[ip] = 0.0; fHodoNegPedLimit[ip] = 0.0; - fHodoPosSigma[ip] = 0.2; - fHodoNegSigma[ip] = 0.2; + fHodoPosSigma[ip] = 0.2; + fHodoNegSigma[ip] = 0.2; } - fTOFCalib_shtrk_lo=-kBig; - fTOFCalib_shtrk_hi= kBig; - fTOFCalib_cer_lo=-kBig; - fTOFCalib_beta_lo=-kBig; - fTOFCalib_beta_hi= kBig; - fdebugprintscinraw=0; - fDumpTOF = 0; - fTOFDumpFile=""; - fTofUsingInvAdc = 1; - fTofTolerance = 3.0; - fNCerNPE = 2.0; - fNormETot = 0.7; - fCosmicFlag=0; - fNumPlanesBetaCalc=4; + fTOFCalib_shtrk_lo = -kBig; + fTOFCalib_shtrk_hi = kBig; + fTOFCalib_cer_lo = -kBig; + fTOFCalib_beta_lo = -kBig; + fTOFCalib_beta_hi = kBig; + fdebugprintscinraw = 0; + fDumpTOF = 0; + fTOFDumpFile = ""; + fTofUsingInvAdc = 1; + fTofTolerance = 3.0; + fNCerNPE = 2.0; + fNormETot = 0.7; + fCosmicFlag = 0; + fNumPlanesBetaCalc = 4; // Gets added to each reference time corrected raw TDC value // to make sure valid range is all positive. - gHcParms->LoadParmValues((DBRequest*)&list,prefix); - if (fCosmicFlag==1) cout << "Setup for cosmics in TOF"<< endl; + gHcParms->LoadParmValues((DBRequest*)&list, prefix); + if (fCosmicFlag == 1) + cout << "Setup for cosmics in TOF" << endl; // cout << " cosmic flag = " << fCosmicFlag << endl; - if(fDumpTOF) { + if (fDumpTOF) { fDumpOut.open(fTOFDumpFile.c_str()); - if(fDumpOut.is_open()) { - //fDumpOut << "Hodoscope Time of Flight calibration data" << endl; + if (fDumpOut.is_open()) { + // fDumpOut << "Hodoscope Time of Flight calibration data" << endl; } else { fDumpTOF = 0; cout << "WARNING: Unable to open TOF Dump file " << fTOFDumpFile << endl; @@ -425,24 +430,23 @@ Int_t THcHodoscope::ReadDatabase( const TDatime& date ) // << " number of photo electrons = " << fNCerNPE // << endl; - //Set scin Velocity/Cable to default - for (UInt_t i=0; i<fMaxHodoScin; i++) { + // Set scin Velocity/Cable to default + for (UInt_t i = 0; i < fMaxHodoScin; i++) { fHodoVelLight[i] = 15.0; } if (fTofUsingInvAdc) { - DBRequest list2[]={ - {"hodo_vel_light", &fHodoVelLight[0], kDouble, fMaxHodoScin, 1}, - {"hodo_pos_invadc_offset",&fHodoPosInvAdcOffset[0],kDouble,fMaxHodoScin}, - {"hodo_neg_invadc_offset",&fHodoNegInvAdcOffset[0],kDouble,fMaxHodoScin}, - {"hodo_pos_invadc_linear",&fHodoPosInvAdcLinear[0],kDouble,fMaxHodoScin}, - {"hodo_neg_invadc_linear",&fHodoNegInvAdcLinear[0],kDouble,fMaxHodoScin}, - {"hodo_pos_invadc_adc",&fHodoPosInvAdcAdc[0],kDouble,fMaxHodoScin}, - {"hodo_neg_invadc_adc",&fHodoNegInvAdcAdc[0],kDouble,fMaxHodoScin}, - {0} - }; - - gHcParms->LoadParmValues((DBRequest*)&list2,prefix); + DBRequest list2[] = { + {"hodo_vel_light", &fHodoVelLight[0], kDouble, fMaxHodoScin, 1}, + {"hodo_pos_invadc_offset", &fHodoPosInvAdcOffset[0], kDouble, fMaxHodoScin}, + {"hodo_neg_invadc_offset", &fHodoNegInvAdcOffset[0], kDouble, fMaxHodoScin}, + {"hodo_pos_invadc_linear", &fHodoPosInvAdcLinear[0], kDouble, fMaxHodoScin}, + {"hodo_neg_invadc_linear", &fHodoNegInvAdcLinear[0], kDouble, fMaxHodoScin}, + {"hodo_pos_invadc_adc", &fHodoPosInvAdcAdc[0], kDouble, fMaxHodoScin}, + {"hodo_neg_invadc_adc", &fHodoNegInvAdcAdc[0], kDouble, fMaxHodoScin}, + {0}}; + + gHcParms->LoadParmValues((DBRequest*)&list2, prefix); }; /* if (!fTofUsingInvAdc) { DBRequest list3[]={ @@ -453,65 +457,60 @@ Int_t THcHodoscope::ReadDatabase( const TDatime& date ) {"hodo_neg_phc_coeff", &fHodoNegPhcCoeff[0], kDouble, fMaxHodoScin}, {"hodo_pos_time_offset", &fHodoPosTimeOffset[0], kDouble, fMaxHodoScin}, {"hodo_neg_time_offset", &fHodoNegTimeOffset[0], kDouble, fMaxHodoScin}, - {0} + {0} }; - - + + gHcParms->LoadParmValues((DBRequest*)&list3,prefix); */ - DBRequest list4[]={ - {"hodo_velFit", &fHodoVelFit[0], kDouble, fMaxHodoScin, 1}, - {"hodo_cableFit", &fHodoCableFit[0], kDouble, fMaxHodoScin, 1}, - {"hodo_LCoeff", &fHodo_LCoeff[0], kDouble, fMaxHodoScin, 1}, - {"c1_Pos", &fHodoPos_c1[0], kDouble, fMaxHodoScin, 1}, - {"c1_Neg", &fHodoNeg_c1[0], kDouble, fMaxHodoScin, 1}, - {"c2_Pos", &fHodoPos_c2[0], kDouble, fMaxHodoScin, 1}, - {"c2_Neg", &fHodoNeg_c2[0], kDouble, fMaxHodoScin, 1}, - {"TDC_threshold", &fTdc_Thrs, kDouble, 0, 1}, - {"hodo_PosSigma", &fHodoSigmaPos[0], kDouble, fMaxHodoScin, 1}, - {"hodo_NegSigma", &fHodoSigmaNeg[0], kDouble, fMaxHodoScin, 1}, - {0} - }; - - fTdc_Thrs = 1.0; - //Set Default Values if NOT defined in param file - for (UInt_t i=0; i<fMaxHodoScin; i++) - { - - //Turn OFF Time-Walk Correction if param file NOT found - fHodoPos_c1[i] = 0.0; - fHodoPos_c2[i] = 0.0; - fHodoNeg_c1[i] = 0.0; - fHodoNeg_c2[i] = 0.0; - } - for (UInt_t i=0; i<fMaxHodoScin; i++) - { - //Set scin Velocity/Cable to default - fHodoCableFit[i] = 0.0; - fHodoVelFit[i] = 15.0; - //set time coeff between paddles to default - fHodo_LCoeff[i] = 0.0; - - } - - gHcParms->LoadParmValues((DBRequest*)&list4,prefix); - - if (fDebug >=1) { - cout <<"******* Testing Hodoscope Parameter Reading ***\n"; - cout<<"StarTimeCenter = "<<fStartTimeCenter<<endl; - cout<<"StartTimeSlop = "<<fStartTimeSlop<<endl; - cout <<"ScintTdcToTime = "<<fScinTdcToTime<<endl; - cout <<"TdcMin = "<<fScinTdcMin<<" TdcMax = "<<fScinTdcMax<<endl; - cout <<"TofTolerance = "<<fTofTolerance<<endl; - cout <<"*** VelLight ***\n"; - for (Int_t i1=0;i1<fNPlanes;i1++) { - cout<<"Plane "<<i1<<endl; - for (UInt_t i2=0;i2<fMaxScinPerPlane;i2++) { - cout<<fHodoVelLight[GetScinIndex(i1,i2)]<<" "; + DBRequest list4[] = {{"hodo_velFit", &fHodoVelFit[0], kDouble, fMaxHodoScin, 1}, + {"hodo_cableFit", &fHodoCableFit[0], kDouble, fMaxHodoScin, 1}, + {"hodo_LCoeff", &fHodo_LCoeff[0], kDouble, fMaxHodoScin, 1}, + {"c1_Pos", &fHodoPos_c1[0], kDouble, fMaxHodoScin, 1}, + {"c1_Neg", &fHodoNeg_c1[0], kDouble, fMaxHodoScin, 1}, + {"c2_Pos", &fHodoPos_c2[0], kDouble, fMaxHodoScin, 1}, + {"c2_Neg", &fHodoNeg_c2[0], kDouble, fMaxHodoScin, 1}, + {"TDC_threshold", &fTdc_Thrs, kDouble, 0, 1}, + {"hodo_PosSigma", &fHodoSigmaPos[0], kDouble, fMaxHodoScin, 1}, + {"hodo_NegSigma", &fHodoSigmaNeg[0], kDouble, fMaxHodoScin, 1}, + {0}}; + + fTdc_Thrs = 1.0; + // Set Default Values if NOT defined in param file + for (UInt_t i = 0; i < fMaxHodoScin; i++) { + + // Turn OFF Time-Walk Correction if param file NOT found + fHodoPos_c1[i] = 0.0; + fHodoPos_c2[i] = 0.0; + fHodoNeg_c1[i] = 0.0; + fHodoNeg_c2[i] = 0.0; + } + for (UInt_t i = 0; i < fMaxHodoScin; i++) { + // Set scin Velocity/Cable to default + fHodoCableFit[i] = 0.0; + fHodoVelFit[i] = 15.0; + // set time coeff between paddles to default + fHodo_LCoeff[i] = 0.0; + } + + gHcParms->LoadParmValues((DBRequest*)&list4, prefix); + + if (fDebug >= 1) { + cout << "******* Testing Hodoscope Parameter Reading ***\n"; + cout << "StarTimeCenter = " << fStartTimeCenter << endl; + cout << "StartTimeSlop = " << fStartTimeSlop << endl; + cout << "ScintTdcToTime = " << fScinTdcToTime << endl; + cout << "TdcMin = " << fScinTdcMin << " TdcMax = " << fScinTdcMax << endl; + cout << "TofTolerance = " << fTofTolerance << endl; + cout << "*** VelLight ***\n"; + for (Int_t i1 = 0; i1 < fNPlanes; i1++) { + cout << "Plane " << i1 << endl; + for (UInt_t i2 = 0; i2 < fMaxScinPerPlane; i2++) { + cout << fHodoVelLight[GetScinIndex(i1, i2)] << " "; } - cout <<endl; + cout << endl; } - cout <<endl<<endl; + cout << endl << endl; // check fHodoPosPhcCoeff /* cout <<"fHodoPosPhcCoeff = "; @@ -523,38 +522,43 @@ Int_t THcHodoscope::ReadDatabase( const TDatime& date ) } // if ((fTofTolerance > 0.5) && (fTofTolerance < 10000.)) { - cout << "USING "<<fTofTolerance<<" NSEC WINDOW FOR FP NO_TRACK CALCULATIONS.\n"; - } - else { - fTofTolerance= 3.0; - cout << "*** USING DEFAULT 3 NSEC WINDOW FOR FP NO_TRACK CALCULATIONS!! ***\n"; + // cout << "USING "<<fTofTolerance<<" NSEC WINDOW FOR FP NO_TRACK CALCULATIONS.\n"; + _det_logger->info("THcHodoscope: Using {} nsec window for fp no_track calculations.", + fTofTolerance); + } else { + fTofTolerance = 3.0; + // cout << "*** USING DEFAULT 3 NSEC WINDOW FOR FP NO_TRACK CALCULATIONS!! ***\n"; + _det_logger->warn("THcHodoscope: Using default {} nsec window for fp no_track calculations.", + fTofTolerance); } - // - fRatio_xpfp_to_xfp=0.00; - TString SHMS="p"; - TString HMS="h"; - TString test=prefix[0]; - if (test==SHMS ) fRatio_xpfp_to_xfp=0.0018; // SHMS - if (test == HMS ) fRatio_xpfp_to_xfp=0.0011; // HMS + fRatio_xpfp_to_xfp = 0.00; + TString SHMS = "p"; + TString HMS = "h"; + TString test = prefix[0]; + if (test == SHMS) + fRatio_xpfp_to_xfp = 0.0018; // SHMS + if (test == HMS) + fRatio_xpfp_to_xfp = 0.0011; // HMS cout << " fRatio_xpfp_to_xfp= " << fRatio_xpfp_to_xfp << endl; - // + fIsInit = true; return kOK; } //_____________________________________________________________________________ -Int_t THcHodoscope::DefineVariables( EMode mode ) -{ +Int_t THcHodoscope::DefineVariables(EMode mode) { /** Initialize global variables for histograms and Root tree */ // cout << "THcHodoscope::DefineVariables called " << GetName() << endl; - if( mode == kDefine && fIsSetup ) return kOK; - fIsSetup = ( mode == kDefine ); + if (mode == kDefine && fIsSetup) + return kOK; + fIsSetup = (mode == kDefine); // Register variables in global list RVarDef vars[] = { +<<<<<<< src/THcHodoscope.cxx // Move these into THcHallCSpectrometer using track fTracks {"beta", "Beta including track info", "fBeta"}, {"betanotrack", "Beta from scintillator hits", "fBetaNoTrk"}, @@ -575,34 +579,62 @@ Int_t THcHodoscope::DefineVariables( EMode mode ) { 0 } }; return DefineVarsFromList( vars, mode ); +======= + // Move these into THcHallCSpectrometer using track fTracks + {"beta", "Beta including track info", "fBeta"}, + {"betanotrack", "Beta from scintillator hits", "fBetaNoTrk"}, + {"betachisqnotrack", "Chi square of beta from scintillator hits", "fBetaNoTrkChiSq"}, + {"fpHitsTime", "Time at focal plane from all hits", "fFPTimeAll"}, + {"starttime", "Hodoscope Start Time", "fStartTime"}, + {"goodstarttime", "Hodoscope Good Start Time (logical flag)", "fGoodStartTime"}, + {"goodscinhit", "Hit in fid area", "fGoodScinHits"}, + {"TimeHist_Sigma", "", "fTimeHist_Sigma"}, + {"TimeHist_Peak", "", "fTimeHist_Peak"}, + {"TimeHist_Hits", "", "fTimeHist_Hits"}, + {0}}; + + return DefineVarsFromList(vars, mode); +>>>>>>> src/THcHodoscope.cxx // return kOK; } +//_____________________________________________________________________________ +Int_t THcHodoscope::ManualInitTree(TTree* t) { + // The most direct path to the output tree!!! + std::string app_name = GetApparatus()->GetName(); + std::string det_name = GetName(); + std::string branch_name = (app_name + "_" + det_name + "_data"); + if (t) { + _det_logger->info("THcHodoscope::ManualInitTree : Adding branch, {}, to output tree", + branch_name); + t->Branch(branch_name.c_str(), &_basic_data, 32000, 99); + } + return 0; +} //_____________________________________________________________________________ -THcHodoscope::~THcHodoscope() -{ + +THcHodoscope::~THcHodoscope() { // Destructor. Remove variables from global list. - delete [] fFPTime; - delete [] fPlaneCenter; - delete [] fPlaneSpacing; + delete[] fFPTime; + delete[] fPlaneCenter; + delete[] fPlaneSpacing; - if( fIsSetup ) + if (fIsSetup) RemoveVariables(); - if( fIsInit ) + if (fIsInit) DeleteArrays(); - for( int i = 0; i < fNPlanes; ++i ) { + for (int i = 0; i < fNPlanes; ++i) { delete fPlanes[i]; - delete [] fPlaneNames[i]; + delete[] fPlaneNames[i]; } - delete [] fPlanes; - delete [] fPlaneNames; + delete[] fPlanes; + delete[] fPlaneNames; } //_____________________________________________________________________________ -void THcHodoscope::DeleteArrays() -{ +void THcHodoscope::DeleteArrays() { // Delete member arrays. Used by destructor. // Int_t k; // for( k = 0; k < fNPlanes; k++){ @@ -610,60 +642,102 @@ void THcHodoscope::DeleteArrays() // } // delete [] fScinHit; - delete [] fxLoScin; fxLoScin = NULL; - delete [] fxHiScin; fxHiScin = NULL; - delete [] fyLoScin; fyLoScin = NULL; - delete [] fyHiScin; fyHiScin = NULL; - delete [] fHodoSlop; fHodoSlop = NULL; - - delete [] fNPaddle; fNPaddle = NULL; - delete [] fHodoVelLight; fHodoVelLight = NULL; - delete [] fHodoPosSigma; fHodoPosSigma = NULL; - delete [] fHodoNegSigma; fHodoNegSigma = NULL; - delete [] fHodoPosMinPh; fHodoPosMinPh = NULL; - delete [] fHodoNegMinPh; fHodoNegMinPh = NULL; - delete [] fHodoPosPhcCoeff; fHodoPosPhcCoeff = NULL; - delete [] fHodoNegPhcCoeff; fHodoNegPhcCoeff = NULL; - delete [] fHodoPosTimeOffset; fHodoPosTimeOffset = NULL; - delete [] fHodoNegTimeOffset; fHodoNegTimeOffset = NULL; - delete [] fHodoPosPedLimit; fHodoPosPedLimit = NULL; - delete [] fHodoNegPedLimit; fHodoNegPedLimit = NULL; - delete [] fHodoPosInvAdcOffset; fHodoPosInvAdcOffset = NULL; - delete [] fHodoNegInvAdcOffset; fHodoNegInvAdcOffset = NULL; - delete [] fHodoPosInvAdcLinear; fHodoPosInvAdcLinear = NULL; - delete [] fHodoNegInvAdcLinear; fHodoNegInvAdcLinear = NULL; - delete [] fHodoPosInvAdcAdc; fHodoPosInvAdcAdc = NULL; - delete [] fHodoNegInvAdcAdc; fHodoNegInvAdcAdc = NULL; - delete [] fGoodPlaneTime; fGoodPlaneTime = NULL; - delete [] fNPlaneTime; fNPlaneTime = NULL; - delete [] fSumPlaneTime; fSumPlaneTime = NULL; - delete [] fNScinHits; fNScinHits = NULL; - delete [] fTdcOffset; fTdcOffset = NULL; - delete [] fAdcTdcOffset; fAdcTdcOffset = NULL; - delete [] fHodoNegAdcTimeWindowMin; fHodoNegAdcTimeWindowMin = NULL; - delete [] fHodoNegAdcTimeWindowMax; fHodoNegAdcTimeWindowMax = NULL; - delete [] fHodoPosAdcTimeWindowMin; fHodoPosAdcTimeWindowMin = NULL; - delete [] fHodoPosAdcTimeWindowMax; fHodoPosAdcTimeWindowMax = NULL; - - delete [] fHodoVelFit; fHodoVelFit = NULL; - delete [] fHodoCableFit; fHodoCableFit = NULL; - delete [] fHodo_LCoeff; fHodo_LCoeff = NULL; - delete [] fHodoPos_c1; fHodoPos_c1 = NULL; - delete [] fHodoNeg_c1; fHodoNeg_c1 = NULL; - delete [] fHodoPos_c2; fHodoPos_c2 = NULL; - delete [] fHodoNeg_c2; fHodoNeg_c2 = NULL; - delete [] fHodoSigmaPos; fHodoSigmaPos = NULL; - delete [] fHodoSigmaNeg; fHodoSigmaNeg = NULL; + delete[] fxLoScin; + fxLoScin = NULL; + delete[] fxHiScin; + fxHiScin = NULL; + delete[] fyLoScin; + fyLoScin = NULL; + delete[] fyHiScin; + fyHiScin = NULL; + delete[] fHodoSlop; + fHodoSlop = NULL; + + delete[] fNPaddle; + fNPaddle = NULL; + delete[] fHodoVelLight; + fHodoVelLight = NULL; + delete[] fHodoPosSigma; + fHodoPosSigma = NULL; + delete[] fHodoNegSigma; + fHodoNegSigma = NULL; + delete[] fHodoPosMinPh; + fHodoPosMinPh = NULL; + delete[] fHodoNegMinPh; + fHodoNegMinPh = NULL; + delete[] fHodoPosPhcCoeff; + fHodoPosPhcCoeff = NULL; + delete[] fHodoNegPhcCoeff; + fHodoNegPhcCoeff = NULL; + delete[] fHodoPosTimeOffset; + fHodoPosTimeOffset = NULL; + delete[] fHodoNegTimeOffset; + fHodoNegTimeOffset = NULL; + delete[] fHodoPosPedLimit; + fHodoPosPedLimit = NULL; + delete[] fHodoNegPedLimit; + fHodoNegPedLimit = NULL; + delete[] fHodoPosInvAdcOffset; + fHodoPosInvAdcOffset = NULL; + delete[] fHodoNegInvAdcOffset; + fHodoNegInvAdcOffset = NULL; + delete[] fHodoPosInvAdcLinear; + fHodoPosInvAdcLinear = NULL; + delete[] fHodoNegInvAdcLinear; + fHodoNegInvAdcLinear = NULL; + delete[] fHodoPosInvAdcAdc; + fHodoPosInvAdcAdc = NULL; + delete[] fHodoNegInvAdcAdc; + fHodoNegInvAdcAdc = NULL; + delete[] fGoodPlaneTime; + fGoodPlaneTime = NULL; + delete[] fNPlaneTime; + fNPlaneTime = NULL; + delete[] fSumPlaneTime; + fSumPlaneTime = NULL; + delete[] fNScinHits; + fNScinHits = NULL; + delete[] fTdcOffset; + fTdcOffset = NULL; + delete[] fAdcTdcOffset; + fAdcTdcOffset = NULL; + delete[] fHodoNegAdcTimeWindowMin; + fHodoNegAdcTimeWindowMin = NULL; + delete[] fHodoNegAdcTimeWindowMax; + fHodoNegAdcTimeWindowMax = NULL; + delete[] fHodoPosAdcTimeWindowMin; + fHodoPosAdcTimeWindowMin = NULL; + delete[] fHodoPosAdcTimeWindowMax; + fHodoPosAdcTimeWindowMax = NULL; + + delete[] fHodoVelFit; + fHodoVelFit = NULL; + delete[] fHodoCableFit; + fHodoCableFit = NULL; + delete[] fHodo_LCoeff; + fHodo_LCoeff = NULL; + delete[] fHodoPos_c1; + fHodoPos_c1 = NULL; + delete[] fHodoNeg_c1; + fHodoNeg_c1 = NULL; + delete[] fHodoPos_c2; + fHodoPos_c2 = NULL; + delete[] fHodoNeg_c2; + fHodoNeg_c2 = NULL; + delete[] fHodoSigmaPos; + fHodoSigmaPos = NULL; + delete[] fHodoSigmaNeg; + fHodoSigmaNeg = NULL; } //_____________________________________________________________________________ -void THcHodoscope::Clear( Option_t* opt ) -{ +void THcHodoscope::Clear(Option_t* opt) { /*! \brief Clears variables * * Called by THcHodoscope::Decode * */ + fTimeHist_StartTime_Sigma= kBig; fTimeHist_StartTime_Peak= kBig; fTimeHist_StartTime_NumPeaks= 0; @@ -673,9 +747,11 @@ void THcHodoscope::Clear( Option_t* opt ) fTimeHist_FpTime_NumPeaks= 0; fTimeHist_FpTime_Hits= kBig; - fBeta = 0.0; - fBetaNoTrk = 0.0; + + fBeta = 0.0; + fBetaNoTrk = 0.0; fBetaNoTrkChiSq = 0.0; + fStartTime = -1000.; fADCStartTime = -1000.; fOffsetTime = kBig; @@ -685,12 +761,13 @@ void THcHodoscope::Clear( Option_t* opt ) if( *opt != 'I' ) { for(Int_t ip=0;ip<fNPlanes;ip++) { + fPlanes[ip]->Clear(); - fFPTime[ip]=0.; - fPlaneCenter[ip]=0.; - fPlaneSpacing[ip]=0.; - for(UInt_t iPaddle=0;iPaddle<fNPaddle[ip]; ++iPaddle) { - fScinHitPaddle[ip][iPaddle]=0; + fFPTime[ip] = 0.; + fPlaneCenter[ip] = 0.; + fPlaneSpacing[ip] = 0.; + for (UInt_t iPaddle = 0; iPaddle < fNPaddle[ip]; ++iPaddle) { + fScinHitPaddle[ip][iPaddle] = 0; } } } @@ -709,23 +786,24 @@ void THcHodoscope::Clear( Option_t* opt ) } //_____________________________________________________________________________ -Int_t THcHodoscope::Decode( const THaEvData& evdata ) -{ - /*! \brief Decodes raw data and processes raw data into hits for each instance of THcScintillatorPlane +Int_t THcHodoscope::Decode(const THaEvData& evdata) { + /*! \brief Decodes raw data and processes raw data into hits for each instance of + * THcScintillatorPlane * * - Reads raw data using THcHitList::DecodeToHitList * - If one wants to subtract pedestals (assumed to be a set of data at beginning of run) * + Must define "Pedestal_event" cut in the cuts definition file * + For each "Pedestal_event" calls THcScintillatorPlane::AccumulatePedestals and returns - * + After First event which is not a "Pedestal_event" calls THcScintillatorPlane::CalculatePedestals + * + After First event which is not a "Pedestal_event" calls + * THcScintillatorPlane::CalculatePedestals * - For each scintillator plane THcScintillatorPlane::ProcessHits * - Calls THcHodoscope::EstimateFocalPlaneTime * * */ // Get the Hall C style hitlist (fRawHitList) for this event - Bool_t present = kTRUE; // Suppress reference time warnings - if(fPresentP) { // if this spectrometer not part of trigger + Bool_t present = kTRUE; // Suppress reference time warnings + if (fPresentP) { // if this spectrometer not part of trigger present = *fPresentP; } fNHits = DecodeToHitList(evdata, !present); @@ -736,58 +814,61 @@ Int_t THcHodoscope::Decode( const THaEvData& evdata ) // cout <<"\nhcana_event " << evdata.GetEvNum()<<endl; fCheckEvent = evdata.GetEvNum(); - fEventType = evdata.GetEvType(); + fEventType = evdata.GetEvType(); - if(gHaCuts->Result("Pedestal_event")) { + if (gHaCuts->Result("Pedestal_event")) { Int_t nexthit = 0; - for(Int_t ip=0;ip<fNPlanes;ip++) { + for (Int_t ip = 0; ip < fNPlanes; ip++) { nexthit = fPlanes[ip]->AccumulatePedestals(fRawHitList, nexthit); } - fAnalyzePedestals = 1; // Analyze pedestals first normal events - return(0); + fAnalyzePedestals = 1; // Analyze pedestals first normal events + return (0); } - if(fAnalyzePedestals) { - for(Int_t ip=0;ip<fNPlanes;ip++) { + if (fAnalyzePedestals) { + for (Int_t ip = 0; ip < fNPlanes; ip++) { fPlanes[ip]->CalculatePedestals(); } - fAnalyzePedestals = 0; // Don't analyze pedestals next event + fAnalyzePedestals = 0; // Don't analyze pedestals next event } // Let each plane get its hits Int_t nexthit = 0; + //THcHallCSpectrometer *app = dynamic_cast<THcHallCSpectrometer*>(GetApparatus()); // cout << " event number = " << fEventNum << " Evtyp = " << fEventType<< " spec = " << app->GetName() << endl; fNfptimes=0; Int_t thits = 0; for(Int_t ip=0;ip<fNPlanes;ip++) { - fPlaneCenter[ip] = fPlanes[ip]->GetPosCenter(0) + fPlanes[ip]->GetPosOffset(); + + fPlaneCenter[ip] = fPlanes[ip]->GetPosCenter(0) + fPlanes[ip]->GetPosOffset(); fPlaneSpacing[ip] = fPlanes[ip]->GetSpacing(); // nexthit = fPlanes[ip]->ProcessHits(fRawHitList, nexthit); // GN: select only events that have reasonable TDC values to start with // as per the Engine h_strip_scin.f - nexthit = fPlanes[ip]->ProcessHits(fRawHitList,nexthit); - thits+=fPlanes[ip]->GetNScinHits(); + nexthit = fPlanes[ip]->ProcessHits(fRawHitList, nexthit); + thits += fPlanes[ip]->GetNScinHits(); } + // // fStartTime=-1000; if (thits>0 ) EstimateFocalPlaneTime(); + if (fdebugprintscinraw == 1) { - for(UInt_t ihit = 0; ihit < fNRawHits ; ihit++) { -// THcRawHodoHit* hit = (THcRawHodoHit *) fRawHitList->At(ihit); -// cout << ihit << " : " << hit->fPlane << ":" << hit->fCounter << " : " -// << hit->fADC_pos << " " << hit->fADC_neg << " " << hit->fTDC_pos -// << " " << hit->fTDC_neg << endl; + for (UInt_t ihit = 0; ihit < fNRawHits; ihit++) { + // THcRawHodoHit* hit = (THcRawHodoHit *) fRawHitList->At(ihit); + // cout << ihit << " : " << hit->fPlane << ":" << hit->fCounter << " : " + // << hit->fADC_pos << " " << hit->fADC_neg << " " << hit->fTDC_pos + // << " " << hit->fTDC_neg << endl; } cout << endl; } - return fNHits; } //_____________________________________________________________________________ @@ -915,21 +996,22 @@ Double_t THcHodoscope::DetermineTimePeak(Int_t FillFlag) } //_____________________________________________________________________________ -void THcHodoscope::EstimateFocalPlaneTime() -{ - /*! \brief Calculates the Drift Chamber start time and fBetaNoTrk (velocity determined without track info) +void THcHodoscope::EstimateFocalPlaneTime() { + /*! \brief Calculates the Drift Chamber start time and fBetaNoTrk (velocity determined without + * track info) * * - Called by THcHodoscope::Decode * - selects good scintillator paddle hits - * + loops through hits in each scintillator plane and fills histogram array, "timehist", with corrected times for positive - * and negative ends of each paddle + * + loops through hits in each scintillator plane and fills histogram array, "timehist", with + * corrected times for positive and negative ends of each paddle * + Determines the peak of "timehist" * */ - Int_t ihit=0; - Int_t nscinhits=0; // Total # hits with at least one good tdc + Int_t ihit = 0; + Int_t nscinhits = 0; // Total # hits with at least one good tdc hTime->Reset(); // + // for(Int_t ip=0;ip<fNPlanes;ip++) { Int_t nphits=fPlanes[ip]->GetNScinHits(); @@ -943,6 +1025,7 @@ void THcHodoscope::EstimateFocalPlaneTime() hTime->Fill(postime); hTime->Fill(negtime); } + } } // @@ -974,6 +1057,7 @@ void THcHodoscope::EstimateFocalPlaneTime() // Double_t AdcTimePeak=DetermineTimePeak(3); // + ihit = 0; Double_t fpTimeSum = 0.0; Double_t adcfpTimeSum = 0.0; @@ -991,12 +1075,14 @@ void THcHodoscope::EstimateFocalPlaneTime() for(Int_t ip=0;ip<fNumPlanesBetaCalc;ip++) { goodplanetime[ip] = kFALSE; Int_t nphits=fPlanes[ip]->GetNScinHits(); + TClonesArray* hodoHits = fPlanes[ip]->GetHits(); - Ngood_hits_plane=0; - Plane_fptime_sum=0.0; - for(Int_t i=0;i<nphits;i++) { - THcHodoHit *hit = (THcHodoHit*)hodoHits->At(i); + Ngood_hits_plane = 0; + Plane_fptime_sum = 0.0; + for (Int_t i = 0; i < nphits; i++) { + THcHodoHit* hit = (THcHodoHit*)hodoHits->At(i); twogoodtimes[ihit] = kFALSE; + if(hit->GetHasCorrectedTimes()) { Double_t postime=hit->GetPosTOFCorrectedTime(); Double_t negtime=hit->GetNegTOFCorrectedTime(); @@ -1070,110 +1156,117 @@ void THcHodoscope::EstimateFocalPlaneTime() fGoodStartTime=kFALSE; fFPTimeAll = fStartTime ; fOffsetTime=AdcTdcDiffTimeSum; + } - // - // + // + // hTime->Reset(); // + if(fGoodStartTime && (goodplanetime[0]||goodplanetime[1]) &&(goodplanetime[2]||goodplanetime[3])) { - Double_t sumW = 0.; - Double_t sumT = 0.; - Double_t sumZ = 0.; + + Double_t sumW = 0.; + Double_t sumT = 0.; + Double_t sumZ = 0.; Double_t sumZZ = 0.; Double_t sumTZ = 0.; - Int_t ihhit = 0; + Int_t ihhit = 0; - for(Int_t ip=0;ip<fNumPlanesBetaCalc;ip++) { - Int_t nphits=fPlanes[ip]->GetNScinHits(); + for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++) { + Int_t nphits = fPlanes[ip]->GetNScinHits(); TClonesArray* hodoHits = fPlanes[ip]->GetHits(); - - for(Int_t i=0;i<nphits;i++) { - Int_t index=((THcHodoHit*)hodoHits->At(i))->GetPaddleNumber()-1; - if(twogoodtimes[ihhit]){ + for (Int_t i = 0; i < nphits; i++) { + Int_t index = ((THcHodoHit*)hodoHits->At(i))->GetPaddleNumber() - 1; - Double_t sigma = 0.0; - if(fTofUsingInvAdc) - { - sigma = 0.5 * ( TMath::Sqrt( TMath::Power( fHodoPosSigma[GetScinIndex(ip,index)],2) + - TMath::Power( fHodoNegSigma[GetScinIndex(ip,index)],2) ) ); - } - else{ - sigma = 0.5 * ( TMath::Sqrt( TMath::Power( fHodoSigmaPos[GetScinIndex(ip,index)],2) + - TMath::Power( fHodoSigmaNeg[GetScinIndex(ip,index)],2) ) ); - } + if (twogoodtimes[ihhit]) { - Double_t scinWeight = 1 / TMath::Power(sigma,2); - Double_t zPosition = fPlanes[ip]->GetZpos() + (index%2)*fPlanes[ip]->GetDzpos(); - // cout << "hit = " << ihhit + 1 << " zpos = " << zPosition << " sigma = " << sigma << endl; - //cout << "fHodoSigma+ = " << fHodoSigmaPos[GetScinIndex(ip,index)] << endl; - sumW += scinWeight; - sumT += scinWeight * ((THcHodoHit*)hodoHits->At(i))->GetScinCorrectedTime(); - sumZ += scinWeight * zPosition; - sumZZ += scinWeight * ( zPosition * zPosition ); - sumTZ += scinWeight * zPosition * ((THcHodoHit*)hodoHits->At(i))->GetScinCorrectedTime(); - - } // condition of good scin time - ihhit ++; + Double_t sigma = 0.0; + if (fTofUsingInvAdc) { + sigma = 0.5 * (TMath::Sqrt(TMath::Power(fHodoPosSigma[GetScinIndex(ip, index)], 2) + + TMath::Power(fHodoNegSigma[GetScinIndex(ip, index)], 2))); + } else { + sigma = 0.5 * (TMath::Sqrt(TMath::Power(fHodoSigmaPos[GetScinIndex(ip, index)], 2) + + TMath::Power(fHodoSigmaNeg[GetScinIndex(ip, index)], 2))); + } + + Double_t scinWeight = 1 / TMath::Power(sigma, 2); + Double_t zPosition = fPlanes[ip]->GetZpos() + (index % 2) * fPlanes[ip]->GetDzpos(); + // cout << "hit = " << ihhit + 1 << " zpos = " << zPosition << " sigma = " << + // sigma << endl; cout << "fHodoSigma+ = " << fHodoSigmaPos[GetScinIndex(ip,index)] << + // endl; + sumW += scinWeight; + sumT += scinWeight * ((THcHodoHit*)hodoHits->At(i))->GetScinCorrectedTime(); + sumZ += scinWeight * zPosition; + sumZZ += scinWeight * (zPosition * zPosition); + sumTZ += scinWeight * zPosition * ((THcHodoHit*)hodoHits->At(i))->GetScinCorrectedTime(); + + } // condition of good scin time + ihhit++; } // loop over hits of plane - } // loop over planes + } // loop over planes - Double_t tmp = sumW * sumZZ - sumZ * sumZ ; - Double_t t0 = ( sumT * sumZZ - sumZ * sumTZ ) / tmp ; + Double_t tmp = sumW * sumZZ - sumZ * sumZ; + Double_t t0 = (sumT * sumZZ - sumZ * sumTZ) / tmp; Double_t tmpDenom = sumW * sumTZ - sumZ * sumT; - if ( TMath::Abs( tmpDenom ) > ( 1 / 10000000000.0 ) ) { + if (TMath::Abs(tmpDenom) > (1 / 10000000000.0)) { - fBetaNoTrk = tmp / tmpDenom; + fBetaNoTrk = tmp / tmpDenom; fBetaNoTrkChiSq = 0.; - ihhit = 0; + ihhit = 0; - for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ){ // Loop over planes - Int_t nphits=fPlanes[ip]->GetNScinHits(); - TClonesArray* hodoHits = fPlanes[ip]->GetHits(); + for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++) { // Loop over planes + Int_t nphits = fPlanes[ip]->GetNScinHits(); + TClonesArray* hodoHits = fPlanes[ip]->GetHits(); - for(Int_t i=0;i<nphits;i++) { - Int_t index=((THcHodoHit*)hodoHits->At(i))->GetPaddleNumber()-1; + for (Int_t i = 0; i < nphits; i++) { + Int_t index = ((THcHodoHit*)hodoHits->At(i))->GetPaddleNumber() - 1; - if(twogoodtimes[ihhit]) { + if (twogoodtimes[ihhit]) { - Double_t zPosition = fPlanes[ip]->GetZpos() + (index%2)*fPlanes[ip]->GetDzpos(); - Double_t timeDif = ( ((THcHodoHit*)hodoHits->At(i))->GetScinCorrectedTime() - t0 ); - - Double_t sigma = 0.0; - if(fTofUsingInvAdc){ - sigma = 0.5 * ( TMath::Sqrt( TMath::Power( fHodoPosSigma[GetScinIndex(ip,index)],2) + - TMath::Power( fHodoNegSigma[GetScinIndex(ip,index)],2) ) ); - } - else { - sigma = 0.5 * ( TMath::Sqrt( TMath::Power( fHodoSigmaPos[GetScinIndex(ip,index)],2) + - TMath::Power( fHodoSigmaNeg[GetScinIndex(ip,index)],2) ) ); - } + Double_t zPosition = fPlanes[ip]->GetZpos() + (index % 2) * fPlanes[ip]->GetDzpos(); + Double_t timeDif = (((THcHodoHit*)hodoHits->At(i))->GetScinCorrectedTime() - t0); - fBetaNoTrkChiSq += ( ( zPosition / fBetaNoTrk - timeDif ) * - ( zPosition / fBetaNoTrk - timeDif ) ) / ( sigma * sigma ); + Double_t sigma = 0.0; + if (fTofUsingInvAdc) { + sigma = 0.5 * (TMath::Sqrt(TMath::Power(fHodoPosSigma[GetScinIndex(ip, index)], 2) + + TMath::Power(fHodoNegSigma[GetScinIndex(ip, index)], 2))); + } else { + sigma = 0.5 * (TMath::Sqrt(TMath::Power(fHodoSigmaPos[GetScinIndex(ip, index)], 2) + + TMath::Power(fHodoSigmaNeg[GetScinIndex(ip, index)], 2))); + } + fBetaNoTrkChiSq += + ((zPosition / fBetaNoTrk - timeDif) * (zPosition / fBetaNoTrk - timeDif)) / + (sigma * sigma); - } // condition for good scin time - ihhit++; - } // loop over hits of a plane - } // loop over planes + } // condition for good scin time + ihhit++; + } // loop over hits of a plane + } // loop over planes Double_t pathNorm = 1.0; fBetaNoTrk = fBetaNoTrk * pathNorm; - fBetaNoTrk = fBetaNoTrk / 29.979; // velocity / c + fBetaNoTrk = fBetaNoTrk / 29.979; // velocity / c - } // condition for fTmpDenom + } // condition for fTmpDenom else { - fBetaNoTrk = 0.; + fBetaNoTrk = 0.; fBetaNoTrkChiSq = -2.; } // else condition for fTmpDenom // - fGoodEventTOFCalib=kFALSE; - if ((fNumPlanesBetaCalc==4)&&goodplanetime[0]&&goodplanetime[1]&&goodplanetime[2]&&goodplanetime[3]&&fPlanes[0]->GetNGoodHits()==1&&fPlanes[1]->GetNGoodHits()==1&&fPlanes[2]->GetNGoodHits()==1&&fPlanes[3]->GetNGoodHits()==1) fGoodEventTOFCalib=kTRUE; - if ((fNumPlanesBetaCalc==3)&&goodplanetime[0]&&goodplanetime[1]&&goodplanetime[2]&&fPlanes[0]->GetNGoodHits()==1&&fPlanes[1]->GetNGoodHits()==1&&fPlanes[2]->GetNGoodHits()==1) fGoodEventTOFCalib=kTRUE; + fGoodEventTOFCalib = kFALSE; + if ((fNumPlanesBetaCalc == 4) && goodplanetime[0] && goodplanetime[1] && goodplanetime[2] && + goodplanetime[3] && fPlanes[0]->GetNGoodHits() == 1 && fPlanes[1]->GetNGoodHits() == 1 && + fPlanes[2]->GetNGoodHits() == 1 && fPlanes[3]->GetNGoodHits() == 1) + fGoodEventTOFCalib = kTRUE; + if ((fNumPlanesBetaCalc == 3) && goodplanetime[0] && goodplanetime[1] && goodplanetime[2] && + fPlanes[0]->GetNGoodHits() == 1 && fPlanes[1]->GetNGoodHits() == 1 && + fPlanes[2]->GetNGoodHits() == 1) + fGoodEventTOFCalib = kTRUE; // // } else { @@ -1182,50 +1275,41 @@ void THcHodoscope::EstimateFocalPlaneTime() } //_____________________________________________________________________________ -Int_t THcHodoscope::ApplyCorrections( void ) -{ - return(0); -} +Int_t THcHodoscope::ApplyCorrections(void) { return (0); } //_____________________________________________________________________________ -Double_t THcHodoscope::TimeWalkCorrection(const Int_t& paddle, - const ESide side) -{ - return(0.0); -} - +Double_t THcHodoscope::TimeWalkCorrection(const Int_t& paddle, const ESide side) { return (0.0); } //_____________________________________________________________________________ -Int_t THcHodoscope::CoarseProcess( TClonesArray& tracks ) -{ +Int_t THcHodoscope::CoarseProcess(TClonesArray& tracks) { - - Int_t ntracks = tracks.GetLast()+1; // Number of reconstructed tracks + Int_t ntracks = tracks.GetLast() + 1; // Number of reconstructed tracks // ------------------------------------------------- // fDumpOut << " ntrack = " << ntracks << endl; - if (ntracks > 0 ) { + if (ntracks > 0) { // **MAIN LOOP: Loop over all tracks and get corrected time, tof, beta... vector<Double_t> nPmtHit(ntracks); vector<Double_t> timeAtFP(ntracks); fdEdX.reserve(ntracks); fGoodFlags.reserve(ntracks); - for ( Int_t itrack = 0; itrack < ntracks; itrack++ ) { // Line 133 - nPmtHit[itrack]=0; - timeAtFP[itrack]=0; - - THaTrack* theTrack = dynamic_cast<THaTrack*>( tracks.At(itrack) ); - if (!theTrack) return -1; - - for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ){ - fGoodPlaneTime[ip] = kFALSE; - fNScinHits[ip] = 0; - fNPlaneTime[ip] = 0; - fSumPlaneTime[ip] = 0.; + for (Int_t itrack = 0; itrack < ntracks; itrack++) { // Line 133 + nPmtHit[itrack] = 0; + timeAtFP[itrack] = 0; + + THaTrack* theTrack = dynamic_cast<THaTrack*>(tracks.At(itrack)); + if (!theTrack) + return -1; + + for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++) { + fGoodPlaneTime[ip] = kFALSE; + fNScinHits[ip] = 0; + fNPlaneTime[ip] = 0; + fSumPlaneTime[ip] = 0.; } - std::vector<Double_t> dedx_temp; - std::vector<std::vector<GoodFlags> > goodflagstmp1; + std::vector<Double_t> dedx_temp; + std::vector<std::vector<GoodFlags>> goodflagstmp1; goodflagstmp1.reserve(fNumPlanesBetaCalc); #if __cplusplus >= 201103L fdEdX.push_back(std::move(dedx_temp)); // Create array of dedx per hit @@ -1234,29 +1318,46 @@ Int_t THcHodoscope::CoarseProcess( TClonesArray& tracks ) fdEdX.push_back(dedx_temp); // Create array of dedx per hit fGoodFlags.push_back(goodflagstmp1); #endif - Int_t nFPTime = 0; + Int_t nFPTime = 0; Double_t betaChiSq = -3; - Double_t beta = 0; + Double_t beta = 0; // timeAtFP[itrack] = 0.; Double_t sumFPTime = 0.; // Line 138 fNScinHit.push_back(0); +//! Calculate all corrected hit times and histogram + //! This uses a copy of code below. Results are save in time_pos,neg + //! including the z-pos. correction assuming nominal value of betap + //! Code is currently hard-wired to look for a peak in the + //! range of 0 to 100 nsec, with a group of times that all + //! agree withing a time_tolerance of time_tolerance nsec. The normal + //! peak position appears to be around 35 nsec. + //! NOTE: if want to find particles with beta different than + //! reference particle, need to make sure this is big enough + //! to accomodate difference in TOF for other particles + //! Default value in case user hasnt defined something reasonable + + // Loop over scintillator planes. + // In ENGINE, its loop over good scintillator hits. (comments from old version) hTime->Reset(); fTOFCalc.clear(); // SAW - Can we fTOFPInfo.clear(); // SAW - combine these two? Int_t ihhit = 0; // Hit # overall - for(Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ) { + + + for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++) { - std::vector<GoodFlags> goodflagstmp2; - goodflagstmp2.reserve(fNScinHits[ip]); + std::vector<GoodFlags> goodflagstmp2; + goodflagstmp2.reserve(fNScinHits[ip]); #if __cplusplus >= 201103L - fGoodFlags[itrack].push_back(std::move(goodflagstmp2)); + fGoodFlags[itrack].push_back(std::move(goodflagstmp2)); #else - fGoodFlags[itrack].push_back(goodflagstmp2); + fGoodFlags[itrack].push_back(goodflagstmp2); #endif + fNScinHits[ip] = fPlanes[ip]->GetNScinHits(); TClonesArray* hodoHits = fPlanes[ip]->GetHits(); @@ -1408,165 +1509,166 @@ Int_t THcHodoscope::CoarseProcess( TClonesArray& tracks ) fTOFPInfo[ih].keep_neg=kTRUE; } } + } //--------------------------------------------------------------------------------------------- - // ---------------------- Second loop over scint. hits in a plane ----------------------------- + // ---------------------- Second loop over scint. hits in a plane + // ----------------------------- //--------------------------------------------------------------------------------------------- - + fdEdX[itrack].reserve(nhits); fTOFCalc.reserve(nhits); - for(Int_t ih=0; ih < nhits; ih++) { - THcHodoHit *hit = fTOFPInfo[ih].hit; - Int_t iphit = fTOFPInfo[ih].hitNumInPlane; - Int_t ip = fTOFPInfo[ih].planeIndex; - // fDumpOut << " looping over hits = " << ih << " plane = " << ip+1 << endl; - // Flags are used by THcHodoEff - fGoodFlags[itrack][ip].reserve(nhits); - fGoodFlags[itrack][ip].push_back(GoodFlags()); - assert( iphit >= 0 && (size_t)iphit < fGoodFlags[itrack][ip].size() ); - fGoodFlags[itrack][ip][iphit].onTrack = kFALSE; - fGoodFlags[itrack][ip][iphit].goodScinTime = kFALSE; - fGoodFlags[itrack][ip][iphit].goodTdcNeg = kFALSE; - fGoodFlags[itrack][ip][iphit].goodTdcPos = kFALSE; - - fTOFCalc.push_back(TOFCalc()); - // Do we set back to false for each track, or just once per event? - assert( ih >= 0 && (size_t)ih < fTOFCalc.size() ); - fTOFCalc[ih].good_scin_time = kFALSE; - // These need a track index too to calculate efficiencies - fTOFCalc[ih].good_tdc_pos = kFALSE; - fTOFCalc[ih].good_tdc_neg = kFALSE; - fTOFCalc[ih].pindex = ip; - - Int_t paddle = hit->GetPaddleNumber()-1; - fTOFCalc[ih].hit_paddle = paddle; - fTOFCalc[ih].good_raw_pad = paddle; - - // Double_t scinCenter = fPlanes[ip]->GetPosCenter(paddle) + fPlanes[ip]->GetPosOffset(); - // Double_t scinTrnsCoord = fTOFPInfo[ih].scinTrnsCoord; - // Double_t scinLongCoord = fTOFPInfo[ih].scinLongCoord; - - Int_t fPIndex = GetScinIndex(ip,paddle); - - if (fTOFPInfo[ih].onTrack) { - fGoodFlags[itrack][ip][iphit].onTrack = kTRUE; - if ( fTOFPInfo[ih].keep_pos ) { // 301 - fTOFCalc[ih].good_tdc_pos = kTRUE; - fGoodFlags[itrack][ip][iphit].goodTdcPos = kTRUE; - } - if ( fTOFPInfo[ih].keep_neg ) { // - fTOFCalc[ih].good_tdc_neg = kTRUE; - fGoodFlags[itrack][ip][iphit].goodTdcNeg = kTRUE; - } - // ** Calculate ave time for scin and error. - if ( fTOFCalc[ih].good_tdc_pos ){ - if ( fTOFCalc[ih].good_tdc_neg ){ - fTOFCalc[ih].scin_time = ( fTOFPInfo[ih].scin_pos_time + - fTOFPInfo[ih].scin_neg_time ) / 2.; - fTOFCalc[ih].scin_time_fp = ( fTOFPInfo[ih].time_pos + - fTOFPInfo[ih].time_neg ) / 2.; - - if (fTofUsingInvAdc){ - fTOFCalc[ih].scin_sigma = TMath::Sqrt( fHodoPosSigma[fPIndex] * fHodoPosSigma[fPIndex] + - fHodoNegSigma[fPIndex] * fHodoNegSigma[fPIndex] )/2.; - } - else { - fTOFCalc[ih].scin_sigma = TMath::Sqrt( fHodoSigmaPos[fPIndex] * fHodoSigmaPos[fPIndex] + - fHodoSigmaNeg[fPIndex] * fHodoSigmaNeg[fPIndex] )/2.; - } - - fTOFCalc[ih].good_scin_time = kTRUE; - fGoodFlags[itrack][ip][iphit].goodScinTime = kTRUE; - } else{ - fTOFCalc[ih].scin_time = fTOFPInfo[ih].scin_pos_time; - fTOFCalc[ih].scin_time_fp = fTOFPInfo[ih].time_pos; - - if (fTofUsingInvAdc){ - fTOFCalc[ih].scin_sigma = fHodoPosSigma[fPIndex]; - } - else{ - fTOFCalc[ih].scin_sigma = fHodoSigmaPos[fPIndex]; - } - - fTOFCalc[ih].good_scin_time = kTRUE; - fGoodFlags[itrack][ip][iphit].goodScinTime = kTRUE; - } - } else { - if ( fTOFCalc[ih].good_tdc_neg ){ - fTOFCalc[ih].scin_time = fTOFPInfo[ih].scin_neg_time; - fTOFCalc[ih].scin_time_fp = fTOFPInfo[ih].time_neg; - if (fTofUsingInvAdc){ - fTOFCalc[ih].scin_sigma = fHodoNegSigma[fPIndex]; - } - else{ - fTOFCalc[ih].scin_sigma = fHodoSigmaNeg[fPIndex]; - } - fTOFCalc[ih].good_scin_time = kTRUE; - fGoodFlags[itrack][ip][iphit].goodScinTime = kTRUE; - } - } // In h_tof.f this includes the following if condition for time at focal plane - // // because it is written in FORTRAN code - - // c Get time at focal plane - if ( fTOFCalc[ih].good_scin_time ){ - - // scin_time_fp doesn't need to be an array - // Is this any different than the average of time_pos and time_neg? - // Double_t scin_time_fp = ( fTOFPInfo[ih].time_pos + - // fTOFPInfo[ih].time_neg ) / 2.; - Double_t scin_time_fp = fTOFCalc[ih].scin_time_fp; - - sumFPTime = sumFPTime + scin_time_fp; - nFPTime ++; - - fSumPlaneTime[ip] = fSumPlaneTime[ip] + scin_time_fp; - fNPlaneTime[ip] ++; - fNScinHit[itrack] ++; - - if ( ( fTOFCalc[ih].good_tdc_pos ) && ( fTOFCalc[ih].good_tdc_neg ) ){ - nPmtHit[itrack] = nPmtHit[itrack] + 2; - } else { - nPmtHit[itrack] = nPmtHit[itrack] + 1; - } - - fdEdX[itrack].push_back(0.0); - assert( fNScinHit[itrack] > 0 && (size_t)fNScinHit[itrack] < fdEdX[itrack].size()+1 ); - - // -------------------------------------------------------------------------------------------- - if ( fTOFCalc[ih].good_tdc_pos ){ - if ( fTOFCalc[ih].good_tdc_neg ){ - fdEdX[itrack][fNScinHit[itrack]-1]= - TMath::Sqrt( TMath::Max( 0., hit->GetPosADC() * hit->GetNegADC() ) ); - } else{ - fdEdX[itrack][fNScinHit[itrack]-1]= - TMath::Max( 0., hit->GetPosADC() ); - } - } else{ - if ( fTOFCalc[ih].good_tdc_neg ){ - fdEdX[itrack][fNScinHit[itrack]-1]= - TMath::Max( 0., hit->GetNegADC() ); - } else{ - fdEdX[itrack][fNScinHit[itrack]-1]=0.0; - } - } - // -------------------------------------------------------------------------------------------- - - - } // time at focal plane condition - } // on track condition + for (Int_t ih = 0; ih < nhits; ih++) { + THcHodoHit* hit = fTOFPInfo[ih].hit; + Int_t iphit = fTOFPInfo[ih].hitNumInPlane; + Int_t ip = fTOFPInfo[ih].planeIndex; + // fDumpOut << " looping over hits = " << ih << " plane = " << ip+1 << endl; + // Flags are used by THcHodoEff + fGoodFlags[itrack][ip].reserve(nhits); + fGoodFlags[itrack][ip].push_back(GoodFlags()); + assert(iphit >= 0 && (size_t)iphit < fGoodFlags[itrack][ip].size()); + fGoodFlags[itrack][ip][iphit].onTrack = kFALSE; + fGoodFlags[itrack][ip][iphit].goodScinTime = kFALSE; + fGoodFlags[itrack][ip][iphit].goodTdcNeg = kFALSE; + fGoodFlags[itrack][ip][iphit].goodTdcPos = kFALSE; + + fTOFCalc.push_back(TOFCalc()); + // Do we set back to false for each track, or just once per event? + assert(ih >= 0 && (size_t)ih < fTOFCalc.size()); + fTOFCalc[ih].good_scin_time = kFALSE; + // These need a track index too to calculate efficiencies + fTOFCalc[ih].good_tdc_pos = kFALSE; + fTOFCalc[ih].good_tdc_neg = kFALSE; + fTOFCalc[ih].pindex = ip; + + Int_t paddle = hit->GetPaddleNumber() - 1; + fTOFCalc[ih].hit_paddle = paddle; + fTOFCalc[ih].good_raw_pad = paddle; + + // Double_t scinCenter = fPlanes[ip]->GetPosCenter(paddle) + + // fPlanes[ip]->GetPosOffset(); Double_t scinTrnsCoord = + // fTOFPInfo[ih].scinTrnsCoord; Double_t scinLongCoord = + // fTOFPInfo[ih].scinLongCoord; + + Int_t fPIndex = GetScinIndex(ip, paddle); + + if (fTOFPInfo[ih].onTrack) { + fGoodFlags[itrack][ip][iphit].onTrack = kTRUE; + if (fTOFPInfo[ih].keep_pos) { // 301 + fTOFCalc[ih].good_tdc_pos = kTRUE; + fGoodFlags[itrack][ip][iphit].goodTdcPos = kTRUE; + } + if (fTOFPInfo[ih].keep_neg) { // + fTOFCalc[ih].good_tdc_neg = kTRUE; + fGoodFlags[itrack][ip][iphit].goodTdcNeg = kTRUE; + } + // ** Calculate ave time for scin and error. + if (fTOFCalc[ih].good_tdc_pos) { + if (fTOFCalc[ih].good_tdc_neg) { + fTOFCalc[ih].scin_time = + (fTOFPInfo[ih].scin_pos_time + fTOFPInfo[ih].scin_neg_time) / 2.; + fTOFCalc[ih].scin_time_fp = (fTOFPInfo[ih].time_pos + fTOFPInfo[ih].time_neg) / 2.; + + if (fTofUsingInvAdc) { + fTOFCalc[ih].scin_sigma = + TMath::Sqrt(fHodoPosSigma[fPIndex] * fHodoPosSigma[fPIndex] + + fHodoNegSigma[fPIndex] * fHodoNegSigma[fPIndex]) / + 2.; + } else { + fTOFCalc[ih].scin_sigma = + TMath::Sqrt(fHodoSigmaPos[fPIndex] * fHodoSigmaPos[fPIndex] + + fHodoSigmaNeg[fPIndex] * fHodoSigmaNeg[fPIndex]) / + 2.; + } + + fTOFCalc[ih].good_scin_time = kTRUE; + fGoodFlags[itrack][ip][iphit].goodScinTime = kTRUE; + } else { + fTOFCalc[ih].scin_time = fTOFPInfo[ih].scin_pos_time; + fTOFCalc[ih].scin_time_fp = fTOFPInfo[ih].time_pos; + + if (fTofUsingInvAdc) { + fTOFCalc[ih].scin_sigma = fHodoPosSigma[fPIndex]; + } else { + fTOFCalc[ih].scin_sigma = fHodoSigmaPos[fPIndex]; + } + + fTOFCalc[ih].good_scin_time = kTRUE; + fGoodFlags[itrack][ip][iphit].goodScinTime = kTRUE; + } + } else { + if (fTOFCalc[ih].good_tdc_neg) { + fTOFCalc[ih].scin_time = fTOFPInfo[ih].scin_neg_time; + fTOFCalc[ih].scin_time_fp = fTOFPInfo[ih].time_neg; + if (fTofUsingInvAdc) { + fTOFCalc[ih].scin_sigma = fHodoNegSigma[fPIndex]; + } else { + fTOFCalc[ih].scin_sigma = fHodoSigmaNeg[fPIndex]; + } + fTOFCalc[ih].good_scin_time = kTRUE; + fGoodFlags[itrack][ip][iphit].goodScinTime = kTRUE; + } + } // In h_tof.f this includes the following if condition for time at focal plane + // // because it is written in FORTRAN code + + // c Get time at focal plane + if (fTOFCalc[ih].good_scin_time) { + + // scin_time_fp doesn't need to be an array + // Is this any different than the average of time_pos and time_neg? + // Double_t scin_time_fp = ( fTOFPInfo[ih].time_pos + + // fTOFPInfo[ih].time_neg ) / 2.; + Double_t scin_time_fp = fTOFCalc[ih].scin_time_fp; + + sumFPTime = sumFPTime + scin_time_fp; + nFPTime++; + + fSumPlaneTime[ip] = fSumPlaneTime[ip] + scin_time_fp; + fNPlaneTime[ip]++; + fNScinHit[itrack]++; + + if ((fTOFCalc[ih].good_tdc_pos) && (fTOFCalc[ih].good_tdc_neg)) { + nPmtHit[itrack] = nPmtHit[itrack] + 2; + } else { + nPmtHit[itrack] = nPmtHit[itrack] + 1; + } + + fdEdX[itrack].push_back(0.0); + assert(fNScinHit[itrack] > 0 && (size_t)fNScinHit[itrack] < fdEdX[itrack].size() + 1); + + // -------------------------------------------------------------------------------------------- + if (fTOFCalc[ih].good_tdc_pos) { + if (fTOFCalc[ih].good_tdc_neg) { + fdEdX[itrack][fNScinHit[itrack] - 1] = + TMath::Sqrt(TMath::Max(0., hit->GetPosADC() * hit->GetNegADC())); + } else { + fdEdX[itrack][fNScinHit[itrack] - 1] = TMath::Max(0., hit->GetPosADC()); + } + } else { + if (fTOFCalc[ih].good_tdc_neg) { + fdEdX[itrack][fNScinHit[itrack] - 1] = TMath::Max(0., hit->GetNegADC()); + } else { + fdEdX[itrack][fNScinHit[itrack] - 1] = 0.0; + } + } + // -------------------------------------------------------------------------------------------- + + } // time at focal plane condition + } // on track condition + + // ** See if there are any good time measurements in the plane. + if (fTOFCalc[ih].good_scin_time) { + fGoodPlaneTime[ip] = kTRUE; + fTOFCalc[ih].dedx = fdEdX[itrack][fNScinHit[itrack] - 1]; + } else { + fTOFCalc[ih].dedx = 0.0; + } - // ** See if there are any good time measurements in the plane. - if ( fTOFCalc[ih].good_scin_time ){ - fGoodPlaneTime[ip] = kTRUE; - fTOFCalc[ih].dedx = fdEdX[itrack][fNScinHit[itrack]-1]; - } else { - fTOFCalc[ih].dedx = 0.0; - } - } // Second loop over hits of a scintillator plane ends here - theTrack->SetGoodPlane3( fGoodPlaneTime[2] ? 1 : 0 ); - if (fNumPlanesBetaCalc==4) theTrack->SetGoodPlane4( fGoodPlaneTime[3] ? 1 : 0 ); + theTrack->SetGoodPlane3(fGoodPlaneTime[2] ? 1 : 0); + if (fNumPlanesBetaCalc == 4) + theTrack->SetGoodPlane4(fGoodPlaneTime[3] ? 1 : 0); // //------------------------------------------------------------------------------ //------------------------------------------------------------------------------ @@ -1579,80 +1681,79 @@ Int_t THcHodoscope::CoarseProcess( TClonesArray& tracks ) // * * Fit beta if there are enough time measurements (one upper, one lower) // From h_tof_fit - if ( ( ( fGoodPlaneTime[0] ) || ( fGoodPlaneTime[1] ) ) && - ( ( fGoodPlaneTime[2] ) || ( fGoodPlaneTime[3] ) ) ){ + if (((fGoodPlaneTime[0]) || (fGoodPlaneTime[1])) && + ((fGoodPlaneTime[2]) || (fGoodPlaneTime[3]))) { - Double_t sumW = 0.; - Double_t sumT = 0.; - Double_t sumZ = 0.; - Double_t sumZZ = 0.; - Double_t sumTZ = 0.; + Double_t sumW = 0.; + Double_t sumT = 0.; + Double_t sumZ = 0.; + Double_t sumZZ = 0.; + Double_t sumTZ = 0.; - for(Int_t ih=0; ih < nhits; ih++) { - Int_t ip = fTOFPInfo[ih].planeIndex; + for (Int_t ih = 0; ih < nhits; ih++) { + Int_t ip = fTOFPInfo[ih].planeIndex; - if ( fTOFCalc[ih].good_scin_time ) { + if (fTOFCalc[ih].good_scin_time) { - Double_t scinWeight = 1 / ( fTOFCalc[ih].scin_sigma * fTOFCalc[ih].scin_sigma ); - Double_t zPosition = ( fPlanes[ip]->GetZpos() - +( fTOFCalc[ih].hit_paddle % 2 ) * - fPlanes[ip]->GetDzpos() ); + Double_t scinWeight = 1 / (fTOFCalc[ih].scin_sigma * fTOFCalc[ih].scin_sigma); + Double_t zPosition = + (fPlanes[ip]->GetZpos() + (fTOFCalc[ih].hit_paddle % 2) * fPlanes[ip]->GetDzpos()); - sumW += scinWeight; - sumT += scinWeight * fTOFCalc[ih].scin_time; - sumZ += scinWeight * zPosition; - sumZZ += scinWeight * ( zPosition * zPosition ); - sumTZ += scinWeight * zPosition * fTOFCalc[ih].scin_time; + sumW += scinWeight; + sumT += scinWeight * fTOFCalc[ih].scin_time; + sumZ += scinWeight * zPosition; + sumZZ += scinWeight * (zPosition * zPosition); + sumTZ += scinWeight * zPosition * fTOFCalc[ih].scin_time; - } // condition of good scin time - } // loop over hits + } // condition of good scin time + } // loop over hits - Double_t tmp = sumW * sumZZ - sumZ * sumZ ; - Double_t t0 = ( sumT * sumZZ - sumZ * sumTZ ) / tmp ; - Double_t tmpDenom = sumW * sumTZ - sumZ * sumT; + Double_t tmp = sumW * sumZZ - sumZ * sumZ; + Double_t t0 = (sumT * sumZZ - sumZ * sumTZ) / tmp; + Double_t tmpDenom = sumW * sumTZ - sumZ * sumT; - if ( TMath::Abs( tmpDenom ) > ( 1 / 10000000000.0 ) ) { + if (TMath::Abs(tmpDenom) > (1 / 10000000000.0)) { - beta = tmp / tmpDenom; - betaChiSq = 0.; + beta = tmp / tmpDenom; + betaChiSq = 0.; - for(Int_t ih=0; ih < nhits; ih++) { - Int_t ip = fTOFPInfo[ih].planeIndex; + for (Int_t ih = 0; ih < nhits; ih++) { + Int_t ip = fTOFPInfo[ih].planeIndex; - if ( fTOFCalc[ih].good_scin_time ){ + if (fTOFCalc[ih].good_scin_time) { - Double_t zPosition = ( fPlanes[ip]->GetZpos() + ( fTOFCalc[ih].hit_paddle % 2 ) * - fPlanes[ip]->GetDzpos() ); - Double_t timeDif = ( fTOFCalc[ih].scin_time - t0 ); - betaChiSq += ( ( zPosition / beta - timeDif ) * - ( zPosition / beta - timeDif ) ) / - ( fTOFCalc[ih].scin_sigma * fTOFCalc[ih].scin_sigma ); + Double_t zPosition = (fPlanes[ip]->GetZpos() + + (fTOFCalc[ih].hit_paddle % 2) * fPlanes[ip]->GetDzpos()); + Double_t timeDif = (fTOFCalc[ih].scin_time - t0); + betaChiSq += ((zPosition / beta - timeDif) * (zPosition / beta - timeDif)) / + (fTOFCalc[ih].scin_sigma * fTOFCalc[ih].scin_sigma); - } // condition for good scin time - } // loop over hits + } // condition for good scin time + } // loop over hits - Double_t pathNorm = TMath::Sqrt( 1. + theTrack->GetTheta() * theTrack->GetTheta() + - theTrack->GetPhi() * theTrack->GetPhi() ); - // Take angle into account - beta = beta / pathNorm; - beta = beta / 29.979; // velocity / c + Double_t pathNorm = TMath::Sqrt(1. + theTrack->GetTheta() * theTrack->GetTheta() + + theTrack->GetPhi() * theTrack->GetPhi()); + // Take angle into account + beta = beta / pathNorm; + beta = beta / 29.979; // velocity / c - } // condition for fTmpDenom - else { - beta = 0.; - betaChiSq = -2.; - } // else condition for fTmpDenom + } // condition for fTmpDenom + else { + beta = 0.; + betaChiSq = -2.; + } // else condition for fTmpDenom } else { - beta = 0.; - betaChiSq = -1; + beta = 0.; + betaChiSq = -1; } - if ( nFPTime != 0 ){ - timeAtFP[itrack] = ( sumFPTime / nFPTime ); + if (nFPTime != 0) { + timeAtFP[itrack] = (sumFPTime / nFPTime); } // // --------------------------------------------------------------------------- + Double_t FPTimeSum=0.0; Int_t nFPTimeSum=0; Int_t nGoodPlanesHit=0; @@ -1676,11 +1777,12 @@ Int_t THcHodoscope::CoarseProcess( TClonesArray& tracks ) dedx = fTOFCalc[ih].dedx; break; } + } theTrack->SetDedx(dedx); theTrack->SetFPTime(fptime); theTrack->SetBeta(beta); - theTrack->SetBetaChi2( betaChiSq ); + theTrack->SetBetaChi2(betaChiSq); theTrack->SetNPMT(nPmtHit[itrack]); @@ -1688,15 +1790,16 @@ Int_t THcHodoscope::CoarseProcess( TClonesArray& tracks ) } // If condition for at least one track - - //OriginalTrackEffTest(); + // OriginalTrackEffTest(); TrackEffTest(); + // CalcCluster(); - return 0; + return 0; } + // void THcHodoscope::CalcCluster(void) { @@ -1839,162 +1942,199 @@ void THcHodoscope::TrackEffTest(void) { Double_t PadLow[4]; Double_t PadHigh[4]; + // assume X planes are 0,2 and Y planes are 1,3 - PadLow[0]=fxLoScin[0]; - PadLow[2]=fxLoScin[1]; - PadLow[1]=fyLoScin[0]; - PadLow[3]=fyLoScin[1]; - PadHigh[0]=fxHiScin[0]; - PadHigh[2]=fxHiScin[1]; - PadHigh[1]=fyHiScin[0]; - PadHigh[3]=fyHiScin[1]; - // - Bool_t efftest_debug = kFALSE; - if (efftest_debug) cout << " spec = " << GetApparatus()->GetName()[0] << endl; - Double_t PadPosLo[4]; - Double_t PadPosHi[4]; - for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ){ - Double_t lowtemp=fPlanes[ip]->GetPosCenter(PadLow[ip]-1)+ fPlanes[ip]->GetPosOffset(); - Double_t hitemp=fPlanes[ip]->GetPosCenter(PadHigh[ip]-1)+ fPlanes[ip]->GetPosOffset(); + std::array<int, 4> PadLow = {fxLoScin[0], fyLoScin[0], fxLoScin[1], fyLoScin[1]}; + std::array<int, 4> PadHigh = {fxHiScin[0], fyHiScin[0], fxHiScin[1], fyHiScin[1]}; + + std::array<double, 4> PadPosLo; + std::array<double, 4> PadPosHi; + + for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++) { + Double_t lowtemp = fPlanes[ip]->GetPosCenter(PadLow[ip] - 1) + fPlanes[ip]->GetPosOffset(); + Double_t hitemp = fPlanes[ip]->GetPosCenter(PadHigh[ip] - 1) + fPlanes[ip]->GetPosOffset(); if (lowtemp < hitemp) { - PadPosLo[ip]=lowtemp; - PadPosHi[ip]=hitemp; + PadPosLo[ip] = lowtemp; + PadPosHi[ip] = hitemp; } else { - PadPosLo[ip]=hitemp; - PadPosHi[ip]=lowtemp; + PadPosLo[ip] = hitemp; + PadPosHi[ip] = lowtemp; } - } - // - const Int_t MaxNClus=5; - std::vector<Int_t > iw(MaxNClus,0); - std::vector<Double_t > dw(MaxNClus,0); - for(Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ) { - fNClust.push_back(0); - fClustSize.push_back(iw); - fClustPos.push_back(dw); } - for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ){ + //{ + // std::vector<int> test_vector = {1,2,5,6,7, 9,10, 20}; + // auto test_res = hcana::find_discontinuity(test_vector); + // std::cout << " find_discontinuity test: " << *test_res << "\n"; + // std::cout << " count_discontinuities test: " << hcana::count_discontinuities(test_vector) + // << "\n"; + // auto cont_ranges = hcana::get_discontinuities(test_vector); + // int ir = 0; + // std::cout << "ranges: \n"; + // for(auto r : cont_ranges) { + // for(auto v = r.first; v< r.second; v++) { + // std::cout << *v << " "; + // } + // std::cout << "\n"; + // } + //} + //{ + // std::vector<int> test_vector = {0,2,4,8,10,12,13, 16,18,20,23}; + // auto test_res = hcana::find_discontinuity( + // test_vector, [](const int& x1, const int& x2) { return x1 + 2 == x2; }); + // std::cout << " find_discontinuity test2: " << *test_res << "\n"; + // std::cout << " count_discontinuities test2: " + // << hcana::count_discontinuities( + // test_vector, [](const int& x1, const int& x2) { return x1 + 2 == x2; }) + // << "\n"; + //} + + using HitIterator = std::vector<THcHodoHit*>::iterator; + using HitRangeVector = typename std::vector<std::pair<HitIterator, HitIterator>>; + using ClusterPositions = typename std::vector<double>; + std::map<int, std::vector<THcHodoHit*>> hit_vecs; + std::vector<HitRangeVector> hit_clusters; + std::vector<ClusterPositions> pos_clusters; + std::vector<std::vector<int>> good_clusters; + std::array<int, 4> n_good_clusters; + // Loop over each plane + for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++) { + + // Get the hit array TClonesArray* hodoHits = fPlanes[ip]->GetHits(); - Int_t prev_padnum=-100; - for (Int_t iphit = 0; iphit < fPlanes[ip]->GetNScinHits(); iphit++ ){ - THcHodoHit *hit = (THcHodoHit*)hodoHits->At(iphit); - Int_t padnum = hit->GetPaddleNumber(); - if ( hit->GetTwoGoodTimes() ) { - if ( padnum==prev_padnum+1 ) { - fClustSize[ip][fNClust[ip]-1]=fClustSize[ip][fNClust[ip]-1]+1; - fClustPos[ip][fNClust[ip]-1]+=fPlanes[ip]->GetPosCenter(padnum-1)+ fPlanes[ip]->GetPosOffset(); - if (efftest_debug) cout << "Add to cluster pl = " << ip+1 << " hit = " << iphit << " pad = " << padnum << " clus = " << fNClust[ip] << " cl size = " << fClustSize[ip][fNClust[ip]-1] << " pos " << fPlanes[ip]->GetPosCenter(padnum-1)+ fPlanes[ip]->GetPosOffset() << endl; - } else { - if (fNClust[ip]<MaxNClus) fNClust[ip]++; - fClustSize[ip][fNClust[ip]-1]=1; - fClustPos[ip][fNClust[ip]-1]=fPlanes[ip]->GetPosCenter(padnum-1)+ fPlanes[ip]->GetPosOffset(); - if (efftest_debug) cout << " New clus pl = " << ip+1 << " hit = " << iphit << " pad = " << padnum << " clus = " << fNClust[ip] << " cl size = " << fClustSize[ip][fNClust[ip]-1] << " pos " << fPlanes[ip]->GetPosCenter(padnum-1)+ fPlanes[ip]->GetPosOffset() << endl; - } - prev_padnum=padnum; + + // Create vector for good hits. + hit_vecs[ip] = std::vector<THcHodoHit*>(); + for (Int_t iphit = 0; iphit < fPlanes[ip]->GetNScinHits(); iphit++) { + THcHodoHit* hit = (THcHodoHit*)hodoHits->At(iphit); + // keep only those with "two good times" + if (hit->GetTwoGoodTimes()) { + hit_vecs[ip].push_back(hit); } - if (!(hit->GetTwoGoodTimes()) && efftest_debug) cout << "no two good times plane = " << ip+1 << " hit = " << iphit << endl; } - } - // - Bool_t inside_bound[4][MaxNClus]; - for(Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ) { - fPlanes[ip]->SetNumberClusters(fNClust[ip]); - for(Int_t ic = 0; ic <fNClust[ip] ; ic++ ) { - fClustPos[ip][ic]=fClustPos[ip][ic]/fClustSize[ip][ic]; - fPlanes[ip]->SetCluster(ic,fClustPos[ip][ic]); - fPlanes[ip]->SetClusterSize(ic,fClustSize[ip][ic]); - inside_bound[ip][ic] = fClustPos[ip][ic]>=PadPosLo[ip] && fClustPos[ip][ic]<=PadPosHi[ip]; - if (efftest_debug) cout << "plane = " << ip+1 << " Cluster = " << ic+1 << " size = " << fClustSize[ip][ic]<< " pos = " << fClustPos[ip][ic] << " inside = " << inside_bound[ip][ic] << " lo = " << PadPosLo[ip]<< " hi = " << PadPosHi[ip]<< endl; - } - } - // - Int_t MaxClusterSize=3; - Int_t good_for_track_test[4][MaxNClus]; - Int_t sum_good_track_test[4]={0,0,0,0}; - Int_t num_good_plane_hit=0; - for(Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ) { - for(Int_t ic = 0; ic <fNClust[ip] ; ic++ ) { - if (inside_bound[ip][ic] && fClustSize[ip][ic]<=MaxClusterSize) { - fPlanes[ip]->SetClusterFlag(ic,1.); - good_for_track_test[ip][ic]=1; - sum_good_track_test[ip]++; - if (sum_good_track_test[ip]==1) num_good_plane_hit++; - } else { - good_for_track_test[ip][ic]=0; - } - if (efftest_debug) cout << " ip " << ip+1 << " clus = " << ic << " good for track = " << good_for_track_test[ip][ic] << endl; + + // Cluster (group adjacent) hits + if (hit_vecs[ip].size() > 0) { + auto& hv = hit_vecs[ip]; + hcana::sort(hv, [](const THcHodoHit* h1, const THcHodoHit* h2) { + return h1->GetPaddleNumber() < h2->GetPaddleNumber(); + }); + + // get the clusters for this layer + hit_clusters.push_back( + hcana::get_discontinuities(hv, [](const THcHodoHit* h1, const THcHodoHit* h2) { + return h1->GetPaddleNumber() + 1 == h2->GetPaddleNumber(); + })); + } else { + hit_clusters.push_back(HitRangeVector{}); } - if (efftest_debug) cout << " ip = " << ip+1 << " sum_good_track_test = " << sum_good_track_test[ip] << endl; - } - if (efftest_debug) cout << " number of planes hits = " << num_good_plane_hit << endl; - // - Bool_t xdiffTest=kFALSE; - Bool_t ydiffTest=kFALSE; - fGoodScinHits = 0; - if (efftest_debug) cout << " fTrackEffTestNScinPlanes = " << fTrackEffTestNScinPlanes << endl; - if ( (fTrackEffTestNScinPlanes == 4 || fTrackEffTestNScinPlanes == 3) && num_good_plane_hit==4) { - - // check for matching clusters in the X planes assumed to be planes 0 and 2 - for(Int_t ic0 = 0; ic0 <fNClust[0] ; ic0++ ) { - for(Int_t ic2 = 0; ic2 <fNClust[2] ; ic2++ ) { - if (good_for_track_test[0][ic0] && good_for_track_test[2][ic2]) { - Double_t x1_proj = fClustPos[0][ic0]*(1+fRatio_xpfp_to_xfp*(fPlanes[2]->GetZpos()-fPlanes[0]->GetZpos())); // project X1 to X2 Z position - xdiffTest= TMath::Abs(x1_proj-fClustPos[2][ic2])<trackeff_scint_xdiff_max; - if (xdiffTest) fPlanes[0]->SetClusterUsedFlag(ic0,1.); - if (xdiffTest) fPlanes[2]->SetClusterUsedFlag(ic2,1.); + fPlanes[ip]->SetNumberClusters(hit_clusters.back().size()); + + // Calculate each cluster's mean position (in one coordinate) + ClusterPositions clust_positions; + std::vector<int> clust_bound; + int ic = 0; + for (auto& r : hit_clusters.back()) { + double a_pos = 0.0; + int n_hit = 0; + for (auto chit = r.first; chit < r.second; chit++) { + a_pos += + fPlanes[ip]->GetPosCenter((*chit)->GetPaddleNumber() - 1) + fPlanes[ip]->GetPosOffset(); + n_hit++; } + // take the average position + double avg_pos = a_pos / double(n_hit); + fPlanes[ip]->SetCluster(ic, avg_pos); + fPlanes[ip]->SetClusterSize(ic, n_hit); + // Calculate if it is the bound by the upper and lower limits where we expect + // full tracks to be reconstructed. + int is_bound = int((avg_pos >= PadPosLo[ip]) && (avg_pos <= PadPosHi[ip])); + clust_bound.push_back(is_bound); + if (is_bound) { + // we are only interested in clusters positioned inthe "sweet spot" + clust_positions.push_back(avg_pos); + n_good_clusters[ip]++; + if (n_hit > 10) { + _det_logger->warn("cluster in hodoscope track efficiency has {} hits", n_hit); + } + } + ic += 1; } + pos_clusters.push_back(clust_positions); + good_clusters.push_back(clust_bound); + //_logger->info("{} clusters in Hod plane {}", hit_clusters.back().size(), ip ); + } + + bool has_both_x_clusters = (n_good_clusters[0] > 0) && (n_good_clusters[2] > 0); + bool has_both_y_clusters = (n_good_clusters[1] > 0) && (n_good_clusters[3] > 0); + bool at_least_one_good_x_clusters = (n_good_clusters[0] > 0) || (n_good_clusters[2] > 0); + bool at_least_one_good_y_clusters = (n_good_clusters[1] > 0) || (n_good_clusters[3] > 0); + bool good_x_match = false; + bool good_y_match = false; + + // Superficial matching. Find out if clusters in front and back could possibly belong to the same + // track. This done by checking to see if the position differences are less than 10 cm; + // ie, |x1-x2|<10 or |y1-y2| <10 + // TODO do actual matching with tracks elsewhere + if (has_both_x_clusters) { + int ic0 = 0; + + // factor to project X1 to X2 z position + const double x1_projection_factor = + (1 + fRatio_xpfp_to_xfp * (fPlanes[2]->GetZpos() - fPlanes[0]->GetZpos())); + + for (auto x1_pos : pos_clusters[0]) { + int ic2 = 0; + // project X1 to X2 Z position + Double_t x1_proj = x1_pos * x1_projection_factor; + for (auto x2_pos : pos_clusters[2]) { + if (std::abs(x1_proj - x2_pos) < trackeff_scint_xdiff_max) { + good_x_match = true; + fPlanes[0]->SetClusterUsedFlag(ic0, 1.); + fPlanes[2]->SetClusterUsedFlag(ic2, 1.); + break; + } + ic2 += 1; + } + ic0 += 1; } - // check for matching clusters in the Y planes assumed to be planes 1 and 3 - for(Int_t ic1 = 0; ic1 <fNClust[1] ; ic1++ ) { - for(Int_t ic3 = 0; ic3 <fNClust[3] ; ic3++ ) { - if (good_for_track_test[1][ic1] && good_for_track_test[3][ic3]) { - ydiffTest= TMath::Abs(fClustPos[1][ic1]-fClustPos[3][ic3])<trackeff_scint_ydiff_max; - if (ydiffTest) fPlanes[1]->SetClusterUsedFlag(ic1,1.); - if (ydiffTest) fPlanes[3]->SetClusterUsedFlag(ic3,1.); - } - } + } + if (has_both_y_clusters) { + int ic1 = 0; + for (auto y1_pos : pos_clusters[1]) { + int ic3 = 0; + for (auto y2_pos : pos_clusters[3]) { + if (std::abs(y1_pos - y2_pos) < trackeff_scint_ydiff_max) { + good_y_match = true; + fPlanes[1]->SetClusterUsedFlag(ic1, 1.); + fPlanes[3]->SetClusterUsedFlag(ic3, 1.); + break; + } + ic3 += 1; + } + ic1 += 1; } - if (xdiffTest && ydiffTest) fGoodScinHits = 1; - if (efftest_debug) cout << " 4 good planes xdiff = " << xdiffTest << " ydiff = " << ydiffTest << endl; } - // - if (fTrackEffTestNScinPlanes == 3 && num_good_plane_hit==3) { - xdiffTest=kFALSE; - ydiffTest=kFALSE; - // Check if two X planes hit - if (sum_good_track_test[0]>0&&sum_good_track_test[2]>0) { - for(Int_t ic0 = 0; ic0 <fNClust[0] ; ic0++ ) { - for(Int_t ic2 = 0; ic2 <fNClust[2] ; ic2++ ) { - if (good_for_track_test[0][ic0] && good_for_track_test[2][ic2]) { - xdiffTest= TMath::Abs(fClustPos[0][ic0]-fClustPos[2][ic2])<trackeff_scint_xdiff_max; - } - } - } - ydiffTest = kTRUE; + + fGoodScinHits = 0; + // (2+2) 4 good hits + if (fTrackEffTestNScinPlanes == 4 || fTrackEffTestNScinPlanes == 3) { + if (good_y_match && good_x_match) { + fGoodScinHits = 1; } - // Check if two Y planes hit - if ((sum_good_track_test[1]>0||sum_good_track_test[3]>0)) { - for(Int_t ic1 = 0; ic1 <fNClust[1] ; ic1++ ) { - for(Int_t ic3 = 0; ic3 <fNClust[3] ; ic3++ ) { - if (good_for_track_test[1][ic1] && good_for_track_test[3][ic3]) { - ydiffTest= TMath::Abs(fClustPos[1][ic1]-fClustPos[3][ic3])<trackeff_scint_ydiff_max; - } + // (2+1) 3 good hits + if (at_least_one_good_y_clusters && good_x_match) { + fGoodScinHits = 1; } - xdiffTest = kTRUE; + // (1+2) 3 good hits + if (at_least_one_good_x_clusters && good_y_match) { + fGoodScinHits = 1; } - } - if (xdiffTest && ydiffTest) fGoodScinHits = 1; - if (efftest_debug) cout << " 3 good planes xdiff = " << xdiffTest << " ydiff = " << ydiffTest << endl; } - if (efftest_debug) cout << " ************" << endl; - // } // // // -void THcHodoscope::OriginalTrackEffTest(void) -{ +void THcHodoscope::OriginalTrackEffTest(void) { /** Translation of h_track_tests.f file for tracking efficiency */ @@ -2002,21 +2142,21 @@ void THcHodoscope::OriginalTrackEffTest(void) //************************now look at some hodoscope tests // *second, we move the scintillators. here we use scintillator cuts to see // *if a track should have been found. - cout << " enter track eff" << fNumPlanesBetaCalc << endl; - for(Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ) { - cout << " loop over planes " << ip+1 << endl; + cout << " enter track eff" << fNumPlanesBetaCalc << endl; + for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++) { + cout << " loop over planes " << ip + 1 << endl; TClonesArray* hodoHits = fPlanes[ip]->GetHits(); // TClonesArray* scinPosTDC = fPlanes[ip]->GetPosTDC(); // TClonesArray* scinNegTDC = fPlanes[ip]->GetNegTDC(); fNScinHits[ip] = fPlanes[ip]->GetNScinHits(); - cout << " hits = " << fNScinHits[ip] << endl; - for (Int_t iphit = 0; iphit < fNScinHits[ip]; iphit++ ){ - Int_t paddle = ((THcHodoHit*)hodoHits->At(iphit))->GetPaddleNumber()-1; + cout << " hits = " << fNScinHits[ip] << endl; + for (Int_t iphit = 0; iphit < fNScinHits[ip]; iphit++) { + Int_t paddle = ((THcHodoHit*)hodoHits->At(iphit))->GetPaddleNumber() - 1; fScinHitPaddle[ip][paddle] = 1; - cout << " hit = " << iphit+1 << " " << paddle+1 << endl; + cout << " hit = " << iphit + 1 << " " << paddle + 1 << endl; } } @@ -2025,7 +2165,7 @@ void THcHodoscope::OriginalTrackEffTest(void) // *Wwe count the number of three adjacent scintillators too. (A signle track // *shouldn't fire three adjacent scintillators. - for(Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ) { + for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++) { // Planes ip = 0 = 1X // Planes ip = 2 = 2X fNClust.push_back(0); @@ -2036,34 +2176,33 @@ void THcHodoscope::OriginalTrackEffTest(void) // *number of scintillators. cout << " looking for cluster in x planes" << endl; Int_t icount; - for (Int_t ip = 0; ip < 3; ip +=2 ) { + for (Int_t ip = 0; ip < 3; ip += 2) { icount = 0; - if ( fScinHitPaddle[ip][0] == 1 ) icount ++; - cout << "plane =" << ip << "check if paddle 1 hit " << icount << endl; + if (fScinHitPaddle[ip][0] == 1) + icount++; + cout << "plane =" << ip << "check if paddle 1 hit " << icount << endl; - for (Int_t ipaddle = 0; ipaddle < (Int_t) fNPaddle[ip] - 1; ipaddle++ ){ + for (Int_t ipaddle = 0; ipaddle < (Int_t)fNPaddle[ip] - 1; ipaddle++) { // !look for number of clusters of 1 or more hits - if ( ( fScinHitPaddle[ip][ipaddle] == 0 ) && - ( fScinHitPaddle[ip][ipaddle + 1] == 1 ) ) - icount ++; - cout << " paddle = " << ipaddle+1 << " " << icount << endl; - + if ((fScinHitPaddle[ip][ipaddle] == 0) && (fScinHitPaddle[ip][ipaddle + 1] == 1)) + icount++; + cout << " paddle = " << ipaddle + 1 << " " << icount << endl; + } // Loop over paddles - cout << "Two cluster in plane = " << ip+1 << " " << icount << endl; + cout << "Two cluster in plane = " << ip + 1 << " " << icount << endl; fNClust[ip] = icount; - icount = 0; + icount = 0; - for (Int_t ipaddle = 0; ipaddle < (Int_t) fNPaddle[ip] - 2; ipaddle++ ){ + for (Int_t ipaddle = 0; ipaddle < (Int_t)fNPaddle[ip] - 2; ipaddle++) { // !look for three or more adjacent hits - if ( ( fScinHitPaddle[ip][ipaddle] == 1 ) && - ( fScinHitPaddle[ip][ipaddle + 1] == 1 ) && - ( fScinHitPaddle[ip][ipaddle + 2] == 1 ) ) - icount ++; + if ((fScinHitPaddle[ip][ipaddle] == 1) && (fScinHitPaddle[ip][ipaddle + 1] == 1) && + (fScinHitPaddle[ip][ipaddle + 2] == 1)) + icount++; } // Second loop over paddles - cout << "Three clusters in plane = " << ip+1 << " " << icount << endl; + cout << "Three clusters in plane = " << ip + 1 << " " << icount << endl; - if ( icount > 0 ) + if (icount > 0) fThreeScin[ip] = 1; } // Loop over X plane @@ -2072,222 +2211,248 @@ void THcHodoscope::OriginalTrackEffTest(void) // *number of scintillators. cout << " looking for cluster in y planes" << endl; - for (Int_t ip = 1; ip < fNumPlanesBetaCalc; ip +=2 ) { + for (Int_t ip = 1; ip < fNumPlanesBetaCalc; ip += 2) { // Planes ip = 1 = 1Y // Planes ip = 3 = 2Y icount = 0; - if ( fScinHitPaddle[ip][0] == 1 ) icount ++; - cout << "plane =" << ip << "check if paddle 1 hit " << icount << endl; + if (fScinHitPaddle[ip][0] == 1) + icount++; + cout << "plane =" << ip << "check if paddle 1 hit " << icount << endl; - for (Int_t ipaddle = 0; ipaddle < (Int_t) fNPaddle[ip] - 1; ipaddle++ ){ + for (Int_t ipaddle = 0; ipaddle < (Int_t)fNPaddle[ip] - 1; ipaddle++) { // !look for number of clusters of 1 or more hits - if ( ( fScinHitPaddle[ip][ipaddle] == 0 ) && - ( fScinHitPaddle[ip][ipaddle + 1] == 1 ) ) - icount ++; - cout << " paddle = " << ipaddle+1 << " " << icount << endl; + if ((fScinHitPaddle[ip][ipaddle] == 0) && (fScinHitPaddle[ip][ipaddle + 1] == 1)) + icount++; + cout << " paddle = " << ipaddle + 1 << " " << icount << endl; } // Loop over Y paddles - cout << "Two cluster in plane = " << ip+1 << " " << icount << endl; + cout << "Two cluster in plane = " << ip + 1 << " " << icount << endl; fNClust[ip] = icount; - icount = 0; + icount = 0; - for (Int_t ipaddle = 0; ipaddle < (Int_t) fNPaddle[ip] - 2; ipaddle++ ){ + for (Int_t ipaddle = 0; ipaddle < (Int_t)fNPaddle[ip] - 2; ipaddle++) { // !look for three or more adjacent hits - if ( ( fScinHitPaddle[ip][ipaddle] == 1 ) && - ( fScinHitPaddle[ip][ipaddle + 1] == 1 ) && - ( fScinHitPaddle[ip][ipaddle + 2] == 1 ) ) - icount ++; + if ((fScinHitPaddle[ip][ipaddle] == 1) && (fScinHitPaddle[ip][ipaddle + 1] == 1) && + (fScinHitPaddle[ip][ipaddle + 2] == 1)) + icount++; } // Second loop over Y paddles - cout << "Three clusters in plane = " << ip+1 << " " << icount << endl; + cout << "Three clusters in plane = " << ip + 1 << " " << icount << endl; - if ( icount > 0 ) + if (icount > 0) fThreeScin[ip] = 1; - }// Loop over Y planes - + } // Loop over Y planes // *next we mask out the edge scintillators, and look at triggers that happened // *at the center of the acceptance. To change which scins are in the mask // *change the values of h*loscin and h*hiscin in htracking.param // fGoodScinHits = 0; - for (Int_t ifidx = fxLoScin[0]; ifidx < (Int_t) fxHiScin[0]; ifidx ++ ){ + for (Int_t ifidx = fxLoScin[0]; ifidx < (Int_t)fxHiScin[0]; ifidx++) { fGoodScinHitsX.push_back(0); } - fHitSweet1X=0; - fHitSweet2X=0; - fHitSweet1Y=0; - fHitSweet2Y=0; + fHitSweet1X = 0; + fHitSweet2X = 0; + fHitSweet1Y = 0; + fHitSweet2Y = 0; // *first x plane. first see if there are hits inside the scin region - for (Int_t ifidx = fxLoScin[0]-1; ifidx < fxHiScin[0]; ifidx ++ ){ - if ( fScinHitPaddle[0][ifidx] == 1 ){ - fHitSweet1X = 1; + for (Int_t ifidx = fxLoScin[0] - 1; ifidx < fxHiScin[0]; ifidx++) { + if (fScinHitPaddle[0][ifidx] == 1) { + fHitSweet1X = 1; fSweet1XScin = ifidx + 1; } } // * next make sure nothing fired outside the good region - for (Int_t ifidx = 0; ifidx < fxLoScin[0]-1; ifidx ++ ){ - if ( fScinHitPaddle[0][ifidx] == 1 ){ fHitSweet1X = -1; } + for (Int_t ifidx = 0; ifidx < fxLoScin[0] - 1; ifidx++) { + if (fScinHitPaddle[0][ifidx] == 1) { + fHitSweet1X = -1; + } } - for (Int_t ifidx = fxHiScin[0]; ifidx < (Int_t) fNPaddle[0]; ifidx ++ ){ - if ( fScinHitPaddle[0][ifidx] == 1 ){ fHitSweet1X = -1; } + for (Int_t ifidx = fxHiScin[0]; ifidx < (Int_t)fNPaddle[0]; ifidx++) { + if (fScinHitPaddle[0][ifidx] == 1) { + fHitSweet1X = -1; + } } // *second x plane. first see if there are hits inside the scin region - for (Int_t ifidx = fxLoScin[1]-1; ifidx < fxHiScin[1]; ifidx ++ ){ - if ( fScinHitPaddle[2][ifidx] == 1 ){ - fHitSweet2X = 1; + for (Int_t ifidx = fxLoScin[1] - 1; ifidx < fxHiScin[1]; ifidx++) { + if (fScinHitPaddle[2][ifidx] == 1) { + fHitSweet2X = 1; fSweet2XScin = ifidx + 1; } } // * next make sure nothing fired outside the good region - for (Int_t ifidx = 0; ifidx < fxLoScin[1]-1; ifidx ++ ){ - if ( fScinHitPaddle[2][ifidx] == 1 ){ fHitSweet2X = -1; } + for (Int_t ifidx = 0; ifidx < fxLoScin[1] - 1; ifidx++) { + if (fScinHitPaddle[2][ifidx] == 1) { + fHitSweet2X = -1; + } } - for (Int_t ifidx = fxHiScin[1]; ifidx < (Int_t) fNPaddle[2]; ifidx ++ ){ - if ( fScinHitPaddle[2][ifidx] == 1 ){ fHitSweet2X = -1; } + for (Int_t ifidx = fxHiScin[1]; ifidx < (Int_t)fNPaddle[2]; ifidx++) { + if (fScinHitPaddle[2][ifidx] == 1) { + fHitSweet2X = -1; + } } // *first y plane. first see if there are hits inside the scin region - for (Int_t ifidx = fyLoScin[0]-1; ifidx < fyHiScin[0]; ifidx ++ ){ - if ( fScinHitPaddle[1][ifidx] == 1 ){ - fHitSweet1Y = 1; + for (Int_t ifidx = fyLoScin[0] - 1; ifidx < fyHiScin[0]; ifidx++) { + if (fScinHitPaddle[1][ifidx] == 1) { + fHitSweet1Y = 1; fSweet1YScin = ifidx + 1; } } // * next make sure nothing fired outside the good region - for (Int_t ifidx = 0; ifidx < fyLoScin[0]-1; ifidx ++ ){ - if ( fScinHitPaddle[1][ifidx] == 1 ){ fHitSweet1Y = -1; } + for (Int_t ifidx = 0; ifidx < fyLoScin[0] - 1; ifidx++) { + if (fScinHitPaddle[1][ifidx] == 1) { + fHitSweet1Y = -1; + } } - for (Int_t ifidx = fyHiScin[0]; ifidx < (Int_t) fNPaddle[1]; ifidx ++ ){ - if ( fScinHitPaddle[1][ifidx] == 1 ){ fHitSweet1Y = -1; } + for (Int_t ifidx = fyHiScin[0]; ifidx < (Int_t)fNPaddle[1]; ifidx++) { + if (fScinHitPaddle[1][ifidx] == 1) { + fHitSweet1Y = -1; + } } // *second y plane. first see if there are hits inside the scin region - for (Int_t ifidx = fyLoScin[1]-1; ifidx < fyHiScin[1]; ifidx ++ ){ - if ( fScinHitPaddle[3][ifidx] == 1 ){ - fHitSweet2Y = 1; + for (Int_t ifidx = fyLoScin[1] - 1; ifidx < fyHiScin[1]; ifidx++) { + if (fScinHitPaddle[3][ifidx] == 1) { + fHitSweet2Y = 1; fSweet2YScin = ifidx + 1; } } // * next make sure nothing fired outside the good region - for (Int_t ifidx = 0; ifidx < fyLoScin[1]-1; ifidx ++ ){ - if ( fScinHitPaddle[3][ifidx] == 1 ){ fHitSweet2Y = -1; } + for (Int_t ifidx = 0; ifidx < fyLoScin[1] - 1; ifidx++) { + if (fScinHitPaddle[3][ifidx] == 1) { + fHitSweet2Y = -1; + } } - for (Int_t ifidx = fyHiScin[1]; ifidx < (Int_t) fNPaddle[3]; ifidx ++ ){ - if ( fScinHitPaddle[3][ifidx] == 1 ){ fHitSweet2Y = -1; } + for (Int_t ifidx = fyHiScin[1]; ifidx < (Int_t)fNPaddle[3]; ifidx++) { + if (fScinHitPaddle[3][ifidx] == 1) { + fHitSweet2Y = -1; + } } fTestSum = fHitSweet1X + fHitSweet2X + fHitSweet1Y + fHitSweet2Y; // * now define a 3/4 or 4/4 trigger of only good scintillators the value // * is specified in htracking - if ( fTestSum >= fTrackEffTestNScinPlanes ){ + if (fTestSum >= fTrackEffTestNScinPlanes) { fGoodScinHits = 1; - for (Int_t ifidx = fxLoScin[0]; ifidx < fxHiScin[0]; ifidx ++ ){ - if ( fSweet1XScin == ifidx ) - fGoodScinHitsX[ifidx] = 1; + for (Int_t ifidx = fxLoScin[0]; ifidx < fxHiScin[0]; ifidx++) { + if (fSweet1XScin == ifidx) + fGoodScinHitsX[ifidx] = 1; } } // * require front/back hodoscopes be close to each other - if ( ( fGoodScinHits == 1 ) && ( fTrackEffTestNScinPlanes == 4 ) ){ - if ( TMath::Abs( fSweet1XScin - fSweet2XScin ) > 3 ) + if ((fGoodScinHits == 1) && (fTrackEffTestNScinPlanes == 4)) { + if (TMath::Abs(fSweet1XScin - fSweet2XScin) > 3) fGoodScinHits = 0; - if ( TMath::Abs( fSweet1YScin - fSweet2YScin ) > 2 ) + if (TMath::Abs(fSweet1YScin - fSweet2YScin) > 2) fGoodScinHits = 0; } -// + // } //_____________________________________________________________________________ -Int_t THcHodoscope::FineProcess( TClonesArray& tracks ) -{ - Int_t Ntracks = tracks.GetLast()+1; // Number of reconstructed tracks +Int_t THcHodoscope::FineProcess(TClonesArray& tracks) { + Int_t Ntracks = tracks.GetLast() + 1; // Number of reconstructed tracks Double_t hitPos; Double_t hitDistance; - Int_t ih=0; - for (Int_t itrk=0; itrk<Ntracks; itrk++) { - THaTrack* theTrack = static_cast<THaTrack*>( tracks[itrk] ); - if (theTrack->GetIndex()==0) { - fBeta=theTrack->GetBeta(); - fFPTimeAll=theTrack->GetFPTime(); - Double_t shower_track_enorm = theTrack->GetEnergy()/theTrack->GetP(); - for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++ ){ - Double_t pl_xypos=0; - Double_t pl_zpos=0; - Int_t num_good_pad=0; - TClonesArray* hodoHits = fPlanes[ip]->GetHits(); - for (Int_t iphit = 0; iphit < fPlanes[ip]->GetNScinHits(); iphit++ ){ - THcHodoHit *hit = fTOFPInfo[ih].hit; - if ( fTOFCalc[ih].good_tdc_pos && fTOFCalc[ih].good_tdc_neg ) { - Bool_t sh_pid=(shower_track_enorm > fTOFCalib_shtrk_lo && shower_track_enorm < fTOFCalib_shtrk_hi); - Bool_t beta_pid=( fBeta > fTOFCalib_beta_lo && fBeta < fTOFCalib_beta_hi); - // cer_pid is true if there is no Cherenkov detector - Bool_t cer_pid=(fCherenkov?(fCherenkov->GetCerNPE()>fTOFCalib_cer_lo):kTRUE); - if(fDumpTOF && Ntracks==1 && fGoodEventTOFCalib && sh_pid && beta_pid && cer_pid) { - fDumpOut << fixed << setprecision(2); - fDumpOut << showpoint << " 1" << setw(3) << ip+1 << setw(3) << hit->GetPaddleNumber() << setw(10) << hit->GetPosTDC()*fScinTdcToTime << setw(10) << fTOFPInfo[ih].pathp << setw(10) << fTOFPInfo[ih].zcor << setw(10) << fTOFPInfo[ih].time_pos << setw(10) << hit->GetPosADC() << endl; - fDumpOut << showpoint << " 2" << setw(3) << ip+1 << setw(3) << hit->GetPaddleNumber() << setw(10) << hit->GetNegTDC()*fScinTdcToTime << setw(10) << fTOFPInfo[ih].pathn << setw(10) << fTOFPInfo[ih].zcor << setw(10) << fTOFPInfo[ih].time_neg << setw(10) << hit->GetNegADC() << endl; - } - Int_t padind = ((THcHodoHit*)hodoHits->At(iphit))->GetPaddleNumber()-1; - pl_xypos+=fPlanes[ip]->GetPosCenter(padind)+ fPlanes[ip]->GetPosOffset(); - pl_zpos+=fPlanes[ip]->GetZpos()+ (padind%2)*fPlanes[ip]->GetDzpos(); - num_good_pad++; - } - ih++; - // cout << ip << " " << iphit << " " << fGoodFlags[itrk][ip][iphit].goodScinTime << " " << fGoodFlags[itrk][ip][iphit].goodTdcPos << " " << fGoodFlags[itrk][ip][iphit].goodTdcNeg << endl; - } - hitDistance=kBig; - if (num_good_pad !=0 ) { - pl_xypos=pl_xypos/num_good_pad; - pl_zpos=pl_zpos/num_good_pad; - hitPos = theTrack->GetY() + theTrack->GetPhi()*pl_zpos ; - if (ip%2 == 0) hitPos = theTrack->GetX() + theTrack->GetTheta()*pl_zpos ; - hitDistance = hitPos - pl_xypos; - fPlanes[ip]->SetTrackXPosition(theTrack->GetX() + theTrack->GetTheta()*pl_zpos ); - fPlanes[ip]->SetTrackYPosition(theTrack->GetY() + theTrack->GetPhi()*pl_zpos ); - } - // cout << " ip " << ip << " " << hitPos << " " << pl_xypos << " " << pl_zpos << " " << hitDistance << endl; - fPlanes[ip]->SetHitDistance(hitDistance); + Int_t ih = 0; + for (Int_t itrk = 0; itrk < Ntracks; itrk++) { + THaTrack* theTrack = static_cast<THaTrack*>(tracks[itrk]); + if (theTrack->GetIndex() == 0) { + fBeta = theTrack->GetBeta(); + fFPTimeAll = theTrack->GetFPTime(); + _basic_data.fBeta = fBeta; + _basic_data.fFPTimeAll = fFPTimeAll; + Double_t shower_track_enorm = theTrack->GetEnergy() / theTrack->GetP(); + for (Int_t ip = 0; ip < fNumPlanesBetaCalc; ip++) { + Double_t pl_xypos = 0; + Double_t pl_zpos = 0; + Int_t num_good_pad = 0; + TClonesArray* hodoHits = fPlanes[ip]->GetHits(); + for (Int_t iphit = 0; iphit < fPlanes[ip]->GetNScinHits(); iphit++) { + THcHodoHit* hit = fTOFPInfo[ih].hit; + if (fTOFCalc[ih].good_tdc_pos && fTOFCalc[ih].good_tdc_neg) { + Bool_t sh_pid = (shower_track_enorm > fTOFCalib_shtrk_lo && + shower_track_enorm < fTOFCalib_shtrk_hi); + Bool_t beta_pid = (fBeta > fTOFCalib_beta_lo && fBeta < fTOFCalib_beta_hi); + // cer_pid is true if there is no Cherenkov detector + Bool_t cer_pid = (fCherenkov ? (fCherenkov->GetCerNPE() > fTOFCalib_cer_lo) : kTRUE); + if (fDumpTOF && Ntracks == 1 && fGoodEventTOFCalib && sh_pid && beta_pid && cer_pid) { + fDumpOut << fixed << setprecision(2); + fDumpOut << showpoint << " 1" << setw(3) << ip + 1 << setw(3) + << hit->GetPaddleNumber() << setw(10) << hit->GetPosTDC() * fScinTdcToTime + << setw(10) << fTOFPInfo[ih].pathp << setw(10) << fTOFPInfo[ih].zcor + << setw(10) << fTOFPInfo[ih].time_pos << setw(10) << hit->GetPosADC() + << endl; + fDumpOut << showpoint << " 2" << setw(3) << ip + 1 << setw(3) + << hit->GetPaddleNumber() << setw(10) << hit->GetNegTDC() * fScinTdcToTime + << setw(10) << fTOFPInfo[ih].pathn << setw(10) << fTOFPInfo[ih].zcor + << setw(10) << fTOFPInfo[ih].time_neg << setw(10) << hit->GetNegADC() + << endl; + } + Int_t padind = ((THcHodoHit*)hodoHits->At(iphit))->GetPaddleNumber() - 1; + pl_xypos += fPlanes[ip]->GetPosCenter(padind) + fPlanes[ip]->GetPosOffset(); + pl_zpos += fPlanes[ip]->GetZpos() + (padind % 2) * fPlanes[ip]->GetDzpos(); + num_good_pad++; + } + ih++; + // cout << ip << " " << iphit << " " << fGoodFlags[itrk][ip][iphit].goodScinTime << + //" " << fGoodFlags[itrk][ip][iphit].goodTdcPos << " " << + // fGoodFlags[itrk][ip][iphit].goodTdcNeg << endl; + } + hitDistance = kBig; + if (num_good_pad != 0) { + pl_xypos = pl_xypos / num_good_pad; + pl_zpos = pl_zpos / num_good_pad; + hitPos = theTrack->GetY() + theTrack->GetPhi() * pl_zpos; + if (ip % 2 == 0) + hitPos = theTrack->GetX() + theTrack->GetTheta() * pl_zpos; + hitDistance = hitPos - pl_xypos; + fPlanes[ip]->SetTrackXPosition(theTrack->GetX() + theTrack->GetTheta() * pl_zpos); + fPlanes[ip]->SetTrackYPosition(theTrack->GetY() + theTrack->GetPhi() * pl_zpos); + } + // cout << " ip " << ip << " " << hitPos << " " << pl_xypos << " " << pl_zpos << " " + // << hitDistance << endl; + fPlanes[ip]->SetHitDistance(hitDistance); } - if(ih>0&&fDumpTOF && Ntracks==1 && fGoodEventTOFCalib && shower_track_enorm > fTOFCalib_shtrk_lo && shower_track_enorm < fTOFCalib_shtrk_hi ) { - fDumpOut << "0 " << endl; + if (ih > 0 && fDumpTOF && Ntracks == 1 && fGoodEventTOFCalib && + shower_track_enorm > fTOFCalib_shtrk_lo && shower_track_enorm < fTOFCalib_shtrk_hi) { + fDumpOut << "0 " << endl; } } - } //over tracks + } // over tracks // return 0; } //_____________________________________________________________________________ -Int_t THcHodoscope::GetScinIndex( Int_t nPlane, Int_t nPaddle ) { +Int_t THcHodoscope::GetScinIndex(Int_t nPlane, Int_t nPaddle) { // GN: Return the index of a scintillator given the plane # and the paddle # // This assumes that both planes and // paddles start counting from 0! // Result also counts from 0. - return fNPlanes*nPaddle+nPlane; + return fNPlanes * nPaddle + nPlane; } //_____________________________________________________________________________ -Int_t THcHodoscope::GetScinIndex( Int_t nSide, Int_t nPlane, Int_t nPaddle ) { - return nSide*fMaxHodoScin+fNPlanes*nPaddle+nPlane-1; +Int_t THcHodoscope::GetScinIndex(Int_t nSide, Int_t nPlane, Int_t nPaddle) { + return nSide * fMaxHodoScin + fNPlanes * nPaddle + nPlane - 1; } //_____________________________________________________________________________ -Double_t THcHodoscope::GetPathLengthCentral() { - return fPathLengthCentral; -} +Double_t THcHodoscope::GetPathLengthCentral() { return fPathLengthCentral; } //_____________________________________________________________________________ -Int_t THcHodoscope::End(THaRunBase* run) -{ +Int_t THcHodoscope::End(THaRunBase* run) { MissReport(Form("%s.%s", GetApparatus()->GetName(), GetName())); return 0; } ClassImp(THcHodoscope) -//////////////////////////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////////////////////////// diff --git a/src/THcHodoscope.h b/src/THcHodoscope.h index ba0b04e04594cd0aa11f2637a93cde2a7adb37c6..42aa72a1fb8dfec305a5559f4ee2cc8eee76e201 100644 --- a/src/THcHodoscope.h +++ b/src/THcHodoscope.h @@ -31,18 +31,45 @@ #include <iostream> #include <fstream> +#include "hcana/Logger.h" +#include "hcana/HallC_Data.h" class THaScCalib; -class THcHodoscope : public THaNonTrackingDetector, public THcHitList { +namespace hallc { + namespace data { + + + struct Hodoscope { + double fBeta = 0.0; + double fBetaNoTrk = 0.0; + double fBetaNoTrkChiSq = 0.0; + double fFPTimeAll = 0.0; + double fStartTime = 0.0; + double fTimeHist_Sigma = 0.0; + double fTimeHist_Peak = 0.0; + double fTimeHist_Hits = 0.0; + bool fGoodStartTime = 0; + bool fGoodScinHits = 0; + ClassDef(Hodoscope,1) + }; + + } // namespace data +} + +class THcHodoscope : public hcana::ConfigLogging<THaNonTrackingDetector>, public THcHitList { public: + + hallc::data::Hodoscope _basic_data; + THcHodoscope( const char* name, const char* description = "", THaApparatus* a = NULL ); virtual ~THcHodoscope(); virtual Int_t Decode( const THaEvData& ); virtual EStatus Init( const TDatime& run_time ); + virtual Int_t ManualInitTree( TTree* t ); virtual void Clear( Option_t* opt="" ); virtual Int_t CoarseProcess( TClonesArray& tracks ); @@ -138,8 +165,18 @@ public: friend class THaScCalib; THcHodoscope(); // for ROOT I/O + + Int_t fGoodScinHits = 0; // Used to indicate hodoscope had good hits that can be used for defining efficiencies + protected: + + // TODO: clean up this class + // Way too many data members!!!!! + // Get rid of junk! + + // Why does this need to be here? + // bad design THcCherenkov* fCherenkov; Int_t fTDC_RefTimeCut; @@ -236,8 +273,6 @@ protected: TClonesArray* fTrackProj; // projection of track onto scintillator plane // and estimated match to TOF paddle - //-------------------------- Ahmed ----------------------------- - Int_t fCheckEvent; Int_t fEventType; @@ -261,7 +296,6 @@ protected: Int_t fdebugprintscinraw; Int_t fTestSum; Int_t fTrackEffTestNScinPlanes; - Int_t fGoodScinHits; Int_t* fxLoScin; Int_t* fxHiScin; Int_t* fyLoScin; diff --git a/src/THcInterface.cxx b/src/THcInterface.cxx index 5ed8668dc699d0db44ef4a31acd70b41f6739a4b..7ca0012569acabf49e1ca252752f7188794da410 100644 --- a/src/THcInterface.cxx +++ b/src/THcInterface.cxx @@ -26,8 +26,8 @@ for the Hall C style parameter database. using namespace std; -THcParmList* gHcParms = NULL; // List of symbolic analyzer variables -THcDetectorMap* gHcDetectorMap = NULL; // Global (Hall C style) detector map +THcParmList* gHcParms = nullptr; // List of symbolic analyzer variables +THcDetectorMap* gHcDetectorMap = nullptr; // Global (Hall C style) detector map //_____________________________________________________________________________ THcInterface::THcInterface( const char* appClassName, int* argc, char** argv, diff --git a/src/THcParmList.cxx b/src/THcParmList.cxx index 240344ce5a66838db2c0015aaf1af5f6f9f52cd7..c2a3c88a47b772a290968e65952403f8c35b186f 100644 --- a/src/THcParmList.cxx +++ b/src/THcParmList.cxx @@ -40,6 +40,10 @@ An instance of THaTextvars is created to hold the string parameters. #define INCLUDESTR "#include" +#include <iomanip> + +#include "TBufferJSON.h" +#include "nlohmann/json.hpp" #include "TObjArray.h" #include "TObjString.h" #include "TSystem.h" @@ -70,7 +74,7 @@ Int_t fDebug = 1; // Keep this at one while we're working on the code ClassImp(THcParmList) /// Create empty numerical and string parameter lists -THcParmList::THcParmList() : THaVarList() +THcParmList::THcParmList() : hcana::ConfigLogging<THaVarList>() { TextList = new THaTextvars; } @@ -128,13 +132,13 @@ The ENGINE CTP support parameter "blocks" which were marked with Int_t nfiles=0; ifiles[nfiles].open(fname); if(ifiles[nfiles].is_open()) { - cout << "Opening parameter file: [" << nfiles << "] " << fname << endl; + //cout << "Opening parameter file: [" << nfiles << "] " << fname << endl; nfiles++; } if(!nfiles) { static const char* const here = "THcParmList::LoadFromFile"; - Error (here, "error opening parameter file %s",fname); + //Error (here, "error opening parameter file %s",fname); return; // Need a success argument returned } @@ -148,7 +152,7 @@ The ENGINE CTP support parameter "blocks" which were marked with if(RunNumber > 0) { InRunRange = 0; // Wait until run number range matching RunNumber is found - cout << "Reading Parameters for run " << RunNumber << endl; + //cout << "Reading Parameters for run " << RunNumber << endl; } else { InRunRange = 1; // Interpret all lines } @@ -183,7 +187,8 @@ The ENGINE CTP support parameter "blocks" which were marked with // cout << line << endl; ifiles[nfiles].open(line.c_str()); if(ifiles[nfiles].is_open()) { - cout << "Opening parameter file: [" << nfiles << "] " << line << endl; + _logger->info("Opening parameter file: [{}] {} ", nfiles, line); + //cout << "Opening parameter file: [" << nfiles << "] " << line << endl; nfiles++; } continue; @@ -294,9 +299,9 @@ The ENGINE CTP support parameter "blocks" which were marked with continue; // Skip to next line } else { if(linecount==1) { - cout << "WARNING: THcParmList::Load in database mode but first line is not" << endl; - cout << " a run number or run number range. Parameter definitions" << endl; - cout << " will be ignored until a run number or range is specified." << endl; + _logger->warn("THcParmList::Load in database mode but first line is not\n" + " a run number or run number range. Parameter definitions\n" + " will be ignored until a run number or range is specified.\n"); } } } @@ -590,15 +595,15 @@ zero), then there will be no error if the parameter is missing. *static_cast<Int_t*>(ti->var)=*(Int_t *)this->Find(key)->GetValuePointer(); } else if (ty == kDouble) { *static_cast<Int_t*>(ti->var)=TMath::Nint(*(Double_t *)this->Find(key)->GetValuePointer()); - cout << "*** WARNING!!! Rounded " << key << " to nearest integer " << endl; + _logger->warn("Rounded {} to nearest integer ",key); } else { - cout << "*** ERROR!!! Type Mismatch " << key << endl; + _logger->error("Type Mismatch {} ",key); } this_cnt=1; break; default: - Error("THcParmList","Invalid type to read %s",key); - break; + _logger->error("THcParmList: Invalid type to read {} ",key); + break; } } } else { // See if it is a text variable @@ -658,8 +663,7 @@ Int_t THcParmList::ReadArray(const char* attrC, T* array, Int_t size) Int_t sz = var->GetLen(); const void *vp = var->GetValuePointer(); if(size != sz) { - cout << "*** WARNING: requested " << size << " elements of " << attrC << - " which has length " << sz << endl; + _logger->warn("requested {} elements of {} which has length {}", size, attrC, sz); } if(size<sz) sz = size; Int_t donint = 0; @@ -681,6 +685,37 @@ Int_t THcParmList::ReadArray(const char* attrC, T* array, Int_t size) } //_____________________________________________________________________________ + +std::string THcParmList::PrintJSON(int run_number ) const { + TIter next(this); + nlohmann::json j; + while( THaVar* obj = (THaVar*) next() ) { + + if( obj->IsBasic() ) { + if( obj->IsArray() ) { + if( obj->GetLen() == 1 ) { + j[obj->GetName()] = obj->GetValue(); + } else { + j[obj->GetName()] = obj->GetValues(); + } + } else { + obj->Print(); + } + } else { + obj->Print(); + } + } + + nlohmann::json jrun; + jrun[std::to_string(run_number)] = j; + //std::cout << j.dump(2) << "\n"; + // write prettified JSON to another file + //std::ofstream o("pretty.json"); + //o << std::setw(4) << jrun << std::endl; + return jrun.dump(2); +} + + void THcParmList::PrintFull( Option_t* option ) const { THaVarList::PrintFull(option); diff --git a/src/THcParmList.h b/src/THcParmList.h index 389d7d6372b46c60ea592a8ca2ba2cbd026407c3..45f83737b2a7bcc61cb905fb460426d68c5dd2e7 100644 --- a/src/THcParmList.h +++ b/src/THcParmList.h @@ -10,6 +10,8 @@ #include "THaVarList.h" #include "THaTextvars.h" +#include "hcana/Logger.h" + #ifdef WITH_CCDB #ifdef __CINT__ struct pthread_cond_t; @@ -23,8 +25,7 @@ using namespace ccdb; using namespace std; - -class THcParmList : public THaVarList { +class THcParmList : public hcana::ConfigLogging<THaVarList> { public: @@ -35,6 +36,8 @@ public: virtual void PrintFull(Option_t *opt="") const; + std::string PrintJSON(int run_number = 0) const; + const char* GetString(const std::string& name) const { return(TextList->Get(name, 0)); } @@ -75,5 +78,23 @@ protected: ClassDef(THcParmList,0) // List of analyzer global parameters }; + + +namespace hcana{ + namespace json { + + template<typename T = double> + T FindVarValueOr(THcParmList* parms, std::string var, T value){ + auto p = parms->Find(var.c_str()); + if(!p) { + return value; + } + const auto res = static_cast<const T*>(p->GetDataPointer()); + return *res; + } + + } +} + #endif diff --git a/src/THcPrimaryKine.cxx b/src/THcPrimaryKine.cxx index 3a6acb9d4ba4a323b691956c3b7888cf64df1181..d1d9b535b4565ef76cc4ee7b11ed623aaff09104 100644 --- a/src/THcPrimaryKine.cxx +++ b/src/THcPrimaryKine.cxx @@ -79,21 +79,21 @@ Int_t THcPrimaryKine::DefineVariables( EMode mode ) fIsSetup = ( mode == kDefine ); RVarDef vars[] = { - { "Q2", "4-momentum transfer squared (GeV^2)", "fQ2" }, - { "omega", "Energy transfer (GeV)", "fOmega" }, - { "W2", "Invariant mass (GeV^2) for Mp ", "fW2" }, - { "W", "Sqrt(Invariant mass) for Mp ", "fW" }, - { "x_bj", "Bjorken x", "fXbj" }, - { "scat_ang_rad", "Scattering angle (rad)", "fScatAngle" }, - { "scat_ang_deg", "Scattering angle (deg)", "fScatAngle_deg" }, - { "epsilon", "Virtual photon polarization factor", "fEpsilon" }, - { "q3m", "Magnitude of 3-momentum transfer", "fQ3mag" }, - { "th_q", "Theta of 3-momentum vector (rad)", "fThetaQ" }, - { "ph_q", "Phi of 3-momentum vector (rad)", "fPhiQ" }, - { "nu", "Energy transfer (GeV)", "fOmega" }, - { "q_x", "x-cmp of Photon vector in the lab", "fQ.X()" }, - { "q_y", "y-cmp of Photon vector in the lab", "fQ.Y()" }, - { "q_z", "z-cmp of Photon vector in the lab", "fQ.Z()" }, + { "Q2" , "4-momentum transfer squared (GeV^2)" , "fQ2" }, + { "omega" , "Energy transfer (GeV)" , "fOmega" }, + { "W2" , "Invariant mass (GeV^2) for Mp " , "fW2" }, + { "W" , "Sqrt(Invariant mass) for Mp " , "fW" }, + { "x_bj" , "Bjorken x" , "fXbj" }, + { "scat_ang_rad" , "Scattering angle (rad)" , "fScatAngle" }, + { "scat_ang_deg" , "Scattering angle (deg)" , "fScatAngle_deg" }, + { "epsilon" , "Virtual photon polarization factor" , "fEpsilon" }, + { "q3m" , "Magnitude of 3-momentum transfer" , "fQ3mag" }, + { "th_q" , "Theta of 3-momentum vector (rad)" , "fThetaQ" }, + { "ph_q" , "Phi of 3-momentum vector (rad)" , "fPhiQ" }, + { "nu" , "Energy transfer (GeV)" , "fOmega" }, + { "q_x" , "x-cmp of Photon vector in the lab" , "fQ.X()" }, + { "q_y" , "y-cmp of Photon vector in the lab" , "fQ.Y()" }, + { "q_z" , "z-cmp of Photon vector in the lab" , "fQ.Z()" }, { 0 } }; return DefineVarsFromList( vars, mode ); @@ -196,13 +196,15 @@ Int_t THcPrimaryKine::ReadDatabase( const TDatime& date ) { #ifdef WITH_DEBUG - cout << "In THcPrimaryKine::ReadDatabase()" << endl; + _param_logger->debug("In THcPrimaryKine::ReadDatabase()" ); #endif char prefix[2]; prefix[0] = tolower(GetName()[0]); prefix[1] = '\0'; + + _param_logger->info("THcPrimaryKine prefix = {}", prefix ); fOopCentralOffset = 0.0; DBRequest list[]={ @@ -219,35 +221,39 @@ Int_t THcPrimaryKine::ReadDatabase( const TDatime& date ) //_____________________________________________________________________________ void THcPrimaryKine::SetMass( Double_t m ) { - if( !IsInit()) - fM = m; - else + if( !IsInit()) { + fM = m; + } else { PrintInitError("SetMass()"); + } } //_____________________________________________________________________________ void THcPrimaryKine::SetTargetMass( Double_t m ) { - if( !IsInit()) - fMA = m; - else + if( !IsInit()) { + fMA = m; + } else { PrintInitError("SetTargetMass()"); + } } //_____________________________________________________________________________ void THcPrimaryKine::SetSpectrometer( const char* name ) { - if( !IsInit()) + if( !IsInit()) { fSpectroName = name; - else + } else { PrintInitError("SetSpectrometer()"); + } } //_____________________________________________________________________________ void THcPrimaryKine::SetBeam( const char* name ) { - if( !IsInit()) + if( !IsInit()) { fBeamName = name; - else + } else { PrintInitError("SetBeam()"); + } } diff --git a/src/THcRaster.cxx b/src/THcRaster.cxx index 628af3b3eb2df70b7ae5cc1a3fc68e245bb61baf..85f41a13ed4a347c612ca288a924627514963605 100644 --- a/src/THcRaster.cxx +++ b/src/THcRaster.cxx @@ -38,7 +38,7 @@ using namespace std; //_____________________________________________________________________________ THcRaster::THcRaster( const char* name, const char* description, THaApparatus* apparatus ) : - THaBeamDet(name,description,apparatus) + hcana::ConfigLogging<THaBeamDet>(name,description,apparatus) { fAnalyzePedestals = 0; @@ -97,7 +97,7 @@ THcRaster::THcRaster( const char* name, const char* description, //_____________________________________________________________________________ THcRaster::THcRaster( ) : - THaBeamDet("THcRaster") // no default constructor available + hcana::ConfigLogging<THaBeamDet>("THcRaster") // no default constructor available { frPosAdcPulseIntRaw = NULL; @@ -246,8 +246,11 @@ Int_t THcRaster::ReadDatabase( const TDatime& date ) if (fgbeam_yoff ==-999.) fgbeam_yoff = 0.; if (fgbeam_xpoff ==-999.) fgbeam_xpoff = 0.; if (fgbeam_ypoff ==-999.) fgbeam_ypoff = 0.; - cout << " THcRaster is using parameters for beam position" << " x = " << fgbeam_xoff<< " y = " << fgbeam_yoff<< endl; - cout << " THcRaster is using parameters for beam angle position" << " xp = " << fgbeam_xpoff<< " yp = " << fgbeam_ypoff<< endl; + + _logger->info("THcRaster parameters for beam position x = {}, y = {}", fgbeam_xoff, fgbeam_yoff); + _logger->info("THcRaster parameters for beam angle position xp= {}, yp= {}", fgbeam_xpoff, fgbeam_ypoff); + //cout << " THcRaster is using parameters for beam position" << " x = " << fgbeam_xoff<< " y = " << fgbeam_yoff<< endl; + //cout << " THcRaster is using parameters for beam angle position" << " xp = " << fgbeam_xpoff<< " yp = " << fgbeam_ypoff<< endl; } diff --git a/src/THcRaster.h b/src/THcRaster.h index a30aa742e95de64053103e676b93d87b0738eec5..9b39c89efb2a9be6e83844df4a3fd8da28575b72 100644 --- a/src/THcRaster.h +++ b/src/THcRaster.h @@ -20,7 +20,9 @@ #include "THaOutput.h" #include "THaEpicsEvtHandler.h" -class THcRaster : public THaBeamDet, public THcHitList { +#include "hcana/Logger.h" + +class THcRaster : public hcana::ConfigLogging<THaBeamDet>, public THcHitList { public: diff --git a/src/THcRawAdcHit.cxx b/src/THcRawAdcHit.cxx index 0f60c651b4c8c39ff32e66843c554c01006a037c..bd8626c23d88978901d1eaa8a960a350a5a78dc0 100644 --- a/src/THcRawAdcHit.cxx +++ b/src/THcRawAdcHit.cxx @@ -88,12 +88,12 @@ Returns 0 if tried to access first pulse but no pulses are set. */ /** -\fn Double_t THcRawAdcHit::GetData(UInt_t iPedLow, UInt_t iPedHigh, UInt_t iIntLow, UInt_t iIntHigh) const -\brief Gets pedestal subtracted integral of samples. In channels. -\param[in] iPedLow Sequential number of first sample to be averaged for pedestal value. -\param[in] iPedHigh Sequential number of last sample to be averaged for pedestal value. -\param[in] iIntLow Sequential number of first sample to be integrated. -\param[in] iIntHigh Sequential number of last sample to be integrated. +\fn Double_t THcRawAdcHit::GetData(UInt_t iPedLow, UInt_t iPedHigh, UInt_t iIntLow, UInt_t iIntHigh) +const \brief Gets pedestal subtracted integral of samples. In channels. \param[in] iPedLow +Sequential number of first sample to be averaged for pedestal value. \param[in] iPedHigh Sequential +number of last sample to be averaged for pedestal value. \param[in] iIntLow Sequential number of +first sample to be integrated. \param[in] iIntHigh Sequential number of last sample to be +integrated. */ /** @@ -183,42 +183,39 @@ Returns 0 if no signal pedestal is set. // TODO: Disallow using both SetData and SetDataTimePedestalPeak. - #include "THcRawAdcHit.h" -#include <stdexcept> #include "TString.h" - const Double_t THcRawAdcHit::fNAdcChan = 4096.0; // Number of FADC channels in units of ADC channels - const Double_t THcRawAdcHit::fAdcRange = 1.0; // Dynamic range of FADCs in units of V, // TO-DO: Get fAdcRange from pre-start event - const Double_t THcRawAdcHit::fAdcImpedence = 50.0; // FADC input impedence in units of Ohms - const Double_t THcRawAdcHit::fAdcTimeSample = 4000.0; // Length of FADC time sample in units of ps - const Double_t THcRawAdcHit::fAdcTimeRes = 0.0625; // FADC time resolution in units of ns - -THcRawAdcHit::THcRawAdcHit() : - TObject(), - fNPedestalSamples(4), fNPeakSamples(9), - fPeakPedestalRatio(1.0*fNPeakSamples/fNPedestalSamples), - fSubsampleToTimeFactor(0.0625), - fPed(0), fPulseInt(), fPulseAmp(), fPulseTime(), fSample(), - fRefTime(0), fHasMulti(kFALSE), fHasRefTime(kFALSE), fNPulses(0), fNSamples(0) -{} +#include <stdexcept> +const Double_t THcRawAdcHit::fNAdcChan = 4096.0; // Number of FADC channels in units of ADC channels +const Double_t THcRawAdcHit::fAdcRange = + 1.0; // Dynamic range of FADCs in units of V, // TO-DO: Get fAdcRange from pre-start event +const Double_t THcRawAdcHit::fAdcImpedence = 50.0; // FADC input impedence in units of Ohms +const Double_t THcRawAdcHit::fAdcTimeSample = 4000.0; // Length of FADC time sample in units of ps +const Double_t THcRawAdcHit::fAdcTimeRes = 0.0625; // FADC time resolution in units of ns + +THcRawAdcHit::THcRawAdcHit() + : podd2::HitLogging<TObject>(), fNPedestalSamples(4), fNPeakSamples(9), + fPeakPedestalRatio(1.0 * fNPeakSamples / fNPedestalSamples), fSubsampleToTimeFactor(0.0625), + fPed(0), fPulseInt(), fPulseAmp(), fPulseTime(), fSample(), fRefTime(0), fHasMulti(kFALSE), + fHasRefTime(kFALSE), fNPulses(0), fNSamples(0) {} THcRawAdcHit& THcRawAdcHit::operator=(const THcRawAdcHit& right) { TObject::operator=(right); if (this != &right) { fPed = right.fPed; - for (UInt_t i=0; i<fMaxNPulses; ++i) { + for (UInt_t i = 0; i < fMaxNPulses; ++i) { fPulseInt[i] = right.fPulseInt[i]; fPulseAmp[i] = right.fPulseAmp[i]; fPulseTime[i] = right.fPulseTime[i]; } - for (UInt_t i=0; i<fMaxNSamples; ++i) { + for (UInt_t i = 0; i < fMaxNSamples; ++i) { fSample[i] = right.fSample[i]; } - fHasMulti = right.fHasMulti; - fNPulses = right.fNPulses; - fNSamples = right.fNSamples; - fRefTime = right.fRefTime; + fHasMulti = right.fHasMulti; + fNPulses = right.fNPulses; + fNSamples = right.fNSamples; + fRefTime = right.fRefTime; fHasRefTime = right.fHasRefTime; } @@ -231,33 +228,33 @@ void THcRawAdcHit::Clear(Option_t* opt) { TObject::Clear(opt); fPed = 0; - for (UInt_t i=0; i<fNPulses; ++i) { - fPulseInt[i] = 0; - fPulseAmp[i] = 0; + for (UInt_t i = 0; i < fNPulses; ++i) { + fPulseInt[i] = 0; + fPulseAmp[i] = 0; fPulseTime[i] = 0; } - for (UInt_t i=0; i<fNSamples; ++i) { - fSample[i] = 0 ; + for (UInt_t i = 0; i < fNSamples; ++i) { + fSample[i] = 0; } - fHasMulti = kFALSE; - fNPulses = 0; - fNSamples = 0; - fRefTime = 0; + fHasMulti = kFALSE; + fNPulses = 0; + fNSamples = 0; + fRefTime = 0; fHasRefTime = kFALSE; } void THcRawAdcHit::SetData(Int_t data) { if (fNPulses >= fMaxNPulses) { - throw std::out_of_range( - "`THcRawAdcHit::SetData`: too many pulses!" - ); + _hit_logger->error("THcRawAdcHit::SetData: too many pulses! Ignoring pulse {}", fNPulses); + // throw std::out_of_range("`THcRawAdcHit::SetData`: too many pulses!"); + return; } fPulseInt[fNPulses] = data; ++fNPulses; } void THcRawAdcHit::SetRefTime(Int_t refTime) { - fRefTime = refTime; + fRefTime = refTime; fHasRefTime = kTRUE; } @@ -267,174 +264,166 @@ void THcRawAdcHit::SetRefDiffTime(Int_t refDiffTime) { void THcRawAdcHit::SetSample(Int_t data) { if (fNSamples >= fMaxNSamples) { - throw std::out_of_range( - "`THcRawAdcHit::SetSample`: too many samples!" - ); + // throw std::out_of_range("`THcRawAdcHit::SetSample`: too many samples!"); + _hit_logger->error("THcRawAdcHit::SetSample: too many samples! Ignoring sample {}", fNSamples); } fSample[fNSamples] = data; ++fNSamples; } -void THcRawAdcHit::SetDataTimePedestalPeak( - Int_t data, Int_t time, Int_t pedestal, Int_t peak -) { +void THcRawAdcHit::SetDataTimePedestalPeak(Int_t data, Int_t time, Int_t pedestal, Int_t peak) { if (fNPulses >= fMaxNPulses) { - throw std::out_of_range( - "`THcRawAdcHit::SetDataTimePedestalPeak`: too many pulses!" - ); + _hit_logger->error("THcRawAdcHit::SetDataTimePedestalPeak: too many pulses! Ignoring pulse {}", + fNPulses); + // throw std::out_of_range("`THcRawAdcHit::SetData`: too many pulses!"); + return; } - fPulseInt[fNPulses] = data; + fPulseInt[fNPulses] = data; fPulseTime[fNPulses] = time; - fPed = pedestal; - fPulseAmp[fNPulses] = peak; - fHasMulti = kTRUE; + fPed = pedestal; + fPulseAmp[fNPulses] = peak; + fHasMulti = kTRUE; ++fNPulses; } Int_t THcRawAdcHit::GetRawData(UInt_t iPulse) const { if (iPulse >= fNPulses && iPulse != 0) { - TString msg = TString::Format( - "`THcRawAdcHit::GetRawData`: requested pulse %d where only %d pulses available!", - iPulse, fNPulses - ); - throw std::out_of_range(msg.Data()); - } - else if (iPulse >= fNPulses && iPulse == 0) { + // TString msg = TString::Format( + // "`THcRawAdcHit::GetRawData`: requested pulse %d where only %d pulses available!", iPulse, + // fNPulses); + // throw std::out_of_range(msg.Data()); + _hit_logger->error( + "THcRawAdcHit::GetRawData: requested pulse {} where only {} pulses available!", iPulse, + fNPulses); return 0; - } - else { + } else if (iPulse >= fNPulses && iPulse == 0) { + return 0; + } else { return fPulseInt[iPulse]; } } Double_t THcRawAdcHit::GetAverage(UInt_t iSampleLow, UInt_t iSampleHigh) const { if (iSampleHigh >= fNSamples || iSampleLow >= fNSamples) { - TString msg = TString::Format( - "`THcRawAdcHit::GetAverage`: not this many samples available!" - ); + TString msg = TString::Format("`THcRawAdcHit::GetAverage`: not this many samples available!"); throw std::out_of_range(msg.Data()); - } - else { + } else { Double_t average = 0.0; - for (UInt_t i=iSampleLow; i<=iSampleHigh; ++i) { + for (UInt_t i = iSampleLow; i <= iSampleHigh; ++i) { average += fSample[i]; } return average / (iSampleHigh - iSampleLow + 1); } } - Int_t THcRawAdcHit::GetIntegral(UInt_t iSampleLow, UInt_t iSampleHigh) const { if (iSampleHigh >= fNSamples || iSampleLow >= fNSamples) { - TString msg = TString::Format( - "`THcRawAdcHit::GetAverage`: not this many samples available!" - ); - throw std::out_of_range(msg.Data()); - } - else { + // TString msg = TString::Format("`THcRawAdcHit::GetAverage`: not this many samples + // available!"); throw std::out_of_range(msg.Data()); + _hit_logger->error("THcRawAdcHit::GetRawData: not this many samples available!"); + return 0; + } else { Int_t integral = 0; - for (UInt_t i=iSampleLow; i<=iSampleHigh; ++i) { + for (UInt_t i = iSampleLow; i <= iSampleHigh; ++i) { integral += fSample[i]; } return integral; } } -Double_t THcRawAdcHit::GetData( - UInt_t iPedLow, UInt_t iPedHigh, UInt_t iIntLow, UInt_t iIntHigh -) const { - return - GetIntegral(iIntLow, iIntHigh) - - GetAverage(iPedHigh, iPedLow) * (iIntHigh - iIntLow + 1); +Double_t THcRawAdcHit::GetData(UInt_t iPedLow, UInt_t iPedHigh, UInt_t iIntLow, + UInt_t iIntHigh) const { + return GetIntegral(iIntLow, iIntHigh) - GetAverage(iPedHigh, iPedLow) * (iIntHigh - iIntLow + 1); } -UInt_t THcRawAdcHit::GetNPulses() const { - return fNPulses; -} +UInt_t THcRawAdcHit::GetNPulses() const { return fNPulses; } -UInt_t THcRawAdcHit::GetNSamples() const { - return fNSamples; -} +UInt_t THcRawAdcHit::GetNSamples() const { return fNSamples; } -Bool_t THcRawAdcHit::HasMulti() const { - return fHasMulti; -} +Bool_t THcRawAdcHit::HasMulti() const { return fHasMulti; } -Int_t THcRawAdcHit::GetPedRaw() const { - return fPed; -} +Int_t THcRawAdcHit::GetPedRaw() const { return fPed; } Int_t THcRawAdcHit::GetPulseIntRaw(UInt_t iPulse) const { if (iPulse < fNPulses) { return fPulseInt[iPulse]; - } - else if (iPulse == 0) { + } else if (iPulse == 0) { + return 0; + } else { + // TString msg = TString::Format( + // "`THcRawAdcHit::GetPulseIntRaw`: Trying to get pulse %d where only %d pulses available!", + // iPulse, fNPulses); + // throw std::out_of_range(msg.Data()); + _hit_logger->error( + "THcRawAdcHit::GetPulseIntRaw: Trying to get pulse {} where only {} pulses available!", + iPulse, fNPulses); return 0; - } - else { - TString msg = TString::Format( - "`THcRawAdcHit::GetPulseIntRaw`: Trying to get pulse %d where only %d pulses available!", - iPulse, fNPulses - ); - throw std::out_of_range(msg.Data()); } } Int_t THcRawAdcHit::GetPulseAmpRaw(UInt_t iPulse) const { if (iPulse < fNPulses) { return fPulseAmp[iPulse]; - } - else if (iPulse == 0) { + } else if (iPulse == 0) { + return 0; + } else { + // TString msg = TString::Format( + // "`THcRawAdcHit::GetPulseAmpRaw`: Trying to get pulse %d where only %d pulses available!", + // iPulse, fNPulses); + // throw std::out_of_range(msg.Data()); + _hit_logger->error( + "THcRawAdcHit::GetPulseIntRaw: Trying to get pulse {} where only {} pulses available!", + iPulse, fNPulses); return 0; - } - else { - TString msg = TString::Format( - "`THcRawAdcHit::GetPulseAmpRaw`: Trying to get pulse %d where only %d pulses available!", - iPulse, fNPulses - ); - throw std::out_of_range(msg.Data()); } } Int_t THcRawAdcHit::GetPulseTimeRaw(UInt_t iPulse) const { if (iPulse < fNPulses) { return fPulseTime[iPulse]; - } - else if (iPulse == 0) { + } else if (iPulse == 0) { + return 0; + } else { + // TString msg = TString::Format( + // "`THcRawAdcHit::GetPulseTimeRaw`: Trying to get pulse %d where only %d pulses available!", + // iPulse, fNPulses); + // throw std::out_of_range(msg.Data()); + _hit_logger->error( + "THcRawAdcHit::GetPulseIntRaw: Trying to get pulse {} where only {} pulses available!", + iPulse, fNPulses); return 0; - } - else { - TString msg = TString::Format( - "`THcRawAdcHit::GetPulseTimeRaw`: Trying to get pulse %d where only %d pulses available!", - iPulse, fNPulses - ); - throw std::out_of_range(msg.Data()); } } Int_t THcRawAdcHit::GetSampleRaw(UInt_t iSample) const { if (iSample < fNSamples) { return fSample[iSample]; - } - else { - TString msg = TString::Format( - "`THcRawAdcHit::GetSampleRaw`: Trying to get sample %d where only %d samples available!", - iSample, fNSamples - ); - throw std::out_of_range(msg.Data()); + } else { + // TString msg = TString::Format( + // "`THcRawAdcHit::GetSampleRaw`: Trying to get sample %d where only %d samples available!", + // iSample, fNSamples); + // throw std::out_of_range(msg.Data()); + _hit_logger->error( + "THcRawAdcHit::GetSampleRaw: Trying to get sample {} where only {} samples available!", + iSample, fNSamples); + return 0; } } Double_t THcRawAdcHit::GetPed() const { - return (static_cast<Double_t>(fPed)/static_cast<Double_t>(fNPedestalSamples))*GetAdcTomV(); + return (static_cast<Double_t>(fPed) / static_cast<Double_t>(fNPedestalSamples)) * GetAdcTomV(); } Double_t THcRawAdcHit::GetPulseInt(UInt_t iPulse) const { - return (static_cast<Double_t>(fPulseInt[iPulse]) - static_cast<Double_t>(fPed)*fPeakPedestalRatio)*GetAdcTopC(); + return (static_cast<Double_t>(fPulseInt[iPulse]) - + static_cast<Double_t>(fPed) * fPeakPedestalRatio) * + GetAdcTopC(); } Double_t THcRawAdcHit::GetPulseAmp(UInt_t iPulse) const { - return (static_cast<Double_t>(fPulseAmp[iPulse]) - static_cast<Double_t>(fPed)/static_cast<Double_t>(fNPedestalSamples))*GetAdcTomV(); + return (static_cast<Double_t>(fPulseAmp[iPulse]) - + static_cast<Double_t>(fPed) / static_cast<Double_t>(fNPedestalSamples)) * + GetAdcTomV(); } Double_t THcRawAdcHit::GetPulseTime(UInt_t iPulse) const { @@ -442,13 +431,13 @@ Double_t THcRawAdcHit::GetPulseTime(UInt_t iPulse) const { if (fHasRefTime) { rawtime -= fRefTime; } - return (static_cast<Double_t>(rawtime)*GetAdcTons()); + return (static_cast<Double_t>(rawtime) * GetAdcTons()); } Int_t THcRawAdcHit::GetSampleIntRaw() const { Int_t integral = 0; - for (UInt_t iSample=0; iSample<fNSamples; ++iSample) { + for (UInt_t iSample = 0; iSample < fNSamples; ++iSample) { integral += fSample[iSample]; } @@ -456,52 +445,47 @@ Int_t THcRawAdcHit::GetSampleIntRaw() const { } Double_t THcRawAdcHit::GetSampleInt() const { - return static_cast<Double_t>(GetSampleIntRaw()) - GetPed()*static_cast<Double_t>(fNSamples); + return static_cast<Double_t>(GetSampleIntRaw()) - GetPed() * static_cast<Double_t>(fNSamples); } void THcRawAdcHit::SetF250Params(Int_t NSA, Int_t NSB, Int_t NPED) { if (NSA < 0 || NSB < 0 || NPED < 0) { - TString msg = TString::Format( - "`THcRawAdcHit::SetF250Params`: One of the params is negative! NSA = %d NSB = %d NPED = %d", - NSA, NSB, NPED - ); + TString msg = TString::Format("`THcRawAdcHit::SetF250Params`: One of the params is negative! " + "NSA = %d NSB = %d NPED = %d", + NSA, NSB, NPED); throw std::invalid_argument(msg.Data()); } - fNPedestalSamples = NPED; - fNPeakSamples = NSA + NSB; - fPeakPedestalRatio = 1.0*fNPeakSamples/fNPedestalSamples; + fNPedestalSamples = NPED; + fNPeakSamples = NSA + NSB; + fPeakPedestalRatio = 1.0 * fNPeakSamples / fNPedestalSamples; } // FADC conversion factors // Convert pedestal and amplitude to mV Double_t THcRawAdcHit::GetAdcTomV() const { // 1000 mV / 4096 ADC channels - return (fAdcRange*1000. / fNAdcChan); + return (fAdcRange * 1000. / fNAdcChan); } // Convert integral to pC Double_t THcRawAdcHit::GetAdcTopC() const { - // (1 V / 4096 adc channels) * (4000 ps time sample / 50 ohms input resistance) = 0.020 pc/channel + // (1 V / 4096 adc channels) * (4000 ps time sample / 50 ohms input resistance) = 0.020 pc/channel return (fAdcRange / fNAdcChan) * (fAdcTimeSample / fAdcImpedence); } // Convert time sub samples to ns -Double_t THcRawAdcHit::GetAdcTons() const { - return fAdcTimeRes; -} +Double_t THcRawAdcHit::GetAdcTons() const { return fAdcTimeRes; } Int_t THcRawAdcHit::GetRefTime() const { if (fHasRefTime) { return fRefTime; - } - else { - TString msg = TString::Format( - "`THcRawAdcHit::GetRefTime`: Reference time not available!" - ); + } else { + TString msg = TString::Format("`THcRawAdcHit::GetRefTime`: Reference time not available!"); throw std::runtime_error(msg.Data()); } } + Int_t THcRawAdcHit::GetRefDiffTime() const { if (fHasRefTime) { return fRefDiffTime; @@ -518,4 +502,5 @@ Bool_t THcRawAdcHit::HasRefTime() const { return fHasRefTime; } + ClassImp(THcRawAdcHit) diff --git a/src/THcRawAdcHit.h b/src/THcRawAdcHit.h index fc31189397173fafc269911f8c9d6db98c04aec3..415275122d99c935d5c879b86b4486a4b6f7c725 100644 --- a/src/THcRawAdcHit.h +++ b/src/THcRawAdcHit.h @@ -3,8 +3,9 @@ #include "TObject.h" +#include "podd2/Logger.h" -class THcRawAdcHit : public TObject { +class THcRawAdcHit : public podd2::HitLogging<TObject> { public: THcRawAdcHit(); THcRawAdcHit& operator=(const THcRawAdcHit& right); @@ -49,6 +50,9 @@ class THcRawAdcHit : public TObject { Double_t GetPulseAmp(UInt_t iPulse=0) const; Double_t GetPulseTime(UInt_t iPulse=0) const; //Int_t GetSample(UInt_t iSample=0) const; + + Int_t* GetSampleBuffer() { return fSample;} + Int_t GetSampleIntRaw() const; Double_t GetSampleInt() const; @@ -63,11 +67,12 @@ class THcRawAdcHit : public TObject { static const UInt_t fMaxNSamples = 511; // FADC conversion factors - static const Double_t fNAdcChan; // Number of FADC channels in units of ADC channels - static const Double_t fAdcRange; // Dynamic range of FADCs in units of V, // TO-DO: Get fAdcRange from pre-start event - static const Double_t fAdcImpedence; // FADC input impedence in units of Ohms - static const Double_t fAdcTimeSample; // Length of FADC time sample in units of ps - static const Double_t fAdcTimeRes; // FADC time resolution in units of ns + static const Double_t fNAdcChan; // Number of FADC channels in units of ADC channels + static const Double_t fAdcRange; // Dynamic range of FADCs in units of V, // TO-DO: Get + // fAdcRange from pre-start event + static const Double_t fAdcImpedence; // FADC input impedence in units of Ohms + static const Double_t fAdcTimeSample; // Length of FADC time sample in units of ps + static const Double_t fAdcTimeRes; // FADC time resolution in units of ns Int_t fNPedestalSamples; // TODO: Get this from prestart event... Int_t fNPeakSamples; @@ -78,7 +83,7 @@ class THcRawAdcHit : public TObject { Int_t fPulseInt[fMaxNPulses]; Int_t fPulseAmp[fMaxNPulses]; Int_t fPulseTime[fMaxNPulses]; - Int_t fSample[fMaxNSamples]; + Int_t fSample[fMaxNSamples]; // the big buffer Int_t fRefTime; Int_t fRefDiffTime; diff --git a/src/THcRawHit.h b/src/THcRawHit.h index e1fb87701b3b253dea3b960aa84ae0409e964af4..74ab5d26c20ebd3995f1a7a9b3bfcbd886df3517 100644 --- a/src/THcRawHit.h +++ b/src/THcRawHit.h @@ -29,13 +29,13 @@ public: // virtual Bool_t operator==( const THcRawHit& ) = 0; // virtual Bool_t operator!=( const THcRawHit& ) = 0; - virtual void SetData(Int_t signal, Int_t data) {}; - virtual void SetSample(Int_t signal, Int_t data) {}; - virtual void SetDataTimePedestalPeak(Int_t signal, Int_t data, - Int_t time, Int_t pedestal, Int_t peak) {}; - virtual Int_t GetData(Int_t signal) {return 0;}; /* Ref time subtracted */ - virtual Int_t GetRawData(Int_t signal) {return 0;} /* Ref time not subtracted */ - virtual ESignalType GetSignalType(Int_t signal) {return kUndefined;} + virtual void SetData(Int_t /* signal */, Int_t /* data */) {}; + virtual void SetSample(Int_t /* signal */, Int_t /* data */) {}; + virtual void SetDataTimePedestalPeak(Int_t /* signal */, Int_t /* data */, + Int_t /* time */, Int_t /* pedestal */, Int_t /* peak */) {}; + virtual Int_t GetData(Int_t /* signal */) {return 0;}; /* Ref time subtracted */ + virtual Int_t GetRawData(Int_t /* signal */) {return 0;} /* Ref time not subtracted */ + virtual ESignalType GetSignalType(Int_t /* signal */) {return kUndefined;} virtual Int_t GetNSignals() { return 1;} virtual void SetReference(Int_t signal, Int_t reference) {}; @@ -43,7 +43,7 @@ public: virtual Bool_t HasReference(Int_t signal) {return kFALSE;}; virtual Int_t GetReference(Int_t signal) {return 0;}; - virtual void SetF250Params(Int_t NSA, Int_t NSB, Int_t NPED) {}; + virtual void SetF250Params(Int_t /* NSA */, Int_t /* NSB */, Int_t /* NPED */) {}; // Derived objects must be sortable and supply Compare method // virtual Bool_t IsSortable () const {return kFALSE; } diff --git a/src/THcScalerEvtHandler.cxx b/src/THcScalerEvtHandler.cxx index d4cf84964aa7e49fd964960e4c7d2824bdacae28..1f06497096487779ffd852c868f87086d6b2b366 100644 --- a/src/THcScalerEvtHandler.cxx +++ b/src/THcScalerEvtHandler.cxx @@ -32,57 +32,54 @@ To enable debugging you may try this in the setup script ~~~ \author E. Brash based on THaScalerEvtHandler by R. Michaels */ +#include <cstdio> +#include <cstdlib> +#include <cstring> +#include <iostream> +#include <iterator> +#include <map> +#include <sstream> -#include "THaEvtTypeHandler.h" #include "THcScalerEvtHandler.h" #include "GenScaler.h" +#include "Helper.h" +#include "Scaler1151.h" #include "Scaler3800.h" #include "Scaler3801.h" -#include "Scaler1151.h" #include "Scaler560.h" #include "Scaler9001.h" #include "Scaler9250.h" #include "THaCodaData.h" #include "THaEvData.h" -#include "THcParmList.h" -#include "THcGlobals.h" +#include "THaEvtTypeHandler.h" #include "THaGlobals.h" -#include "TNamed.h" +#include "THaVarList.h" +#include "THcGlobals.h" +#include "THcParmList.h" #include "TMath.h" -#include "TString.h" +#include "TNamed.h" #include "TROOT.h" -#include <cstring> -#include <cstdio> -#include <cstdlib> -#include <iostream> -#include <sstream> -#include <map> -#include <iterator> -#include "THaVarList.h" +#include "TString.h" #include "VarDef.h" -#include "Helper.h" using namespace std; using namespace Decoder; static const UInt_t ICOUNT = 1; static const UInt_t IRATE = 2; -static const UInt_t ICURRENT = 3; +static const UInt_t ICURRENT = 3; static const UInt_t ICHARGE = 4; -static const UInt_t ITIME = 5; -static const UInt_t ICUT = 6; +static const UInt_t ITIME = 5; +static const UInt_t ICUT = 6; static const UInt_t MAXCHAN = 32; static const UInt_t defaultDT = 4; -THcScalerEvtHandler::THcScalerEvtHandler(const char *name, const char* description) - : THaEvtTypeHandler(name,description), - fBCM_Gain(0), fBCM_Offset(0), fBCM_SatOffset(0), fBCM_SatQuadratic(0), fBCM_delta_charge(0), - evcount(0), evcountR(0.0), ifound(0), fNormIdx(-1), - fNormSlot(-1), - dvars(0),dvars_prev_read(0), dvarsFirst(0), fScalerTree(0), fUseFirstEvent(kTRUE), - fOnlySyncEvents(kFALSE), fOnlyBanks(kFALSE), fDelayedType(-1), - fClockChan(-1), fLastClock(0), fClockOverflows(0) -{ +THcScalerEvtHandler::THcScalerEvtHandler(const char* name, const char* description) + : hcana::ConfigLogging<THaEvtTypeHandler>(name, description), fBCM_Gain(0), fBCM_Offset(0), + fBCM_SatOffset(0), fBCM_SatQuadratic(0), fBCM_delta_charge(0), evcount(0), evcountR(0.0), + ifound(0), fNormIdx(-1), fNormSlot(-1), dvars(0), dvars_prev_read(0), dvarsFirst(0), + fScalerTree(0), fUseFirstEvent(kTRUE), fOnlySyncEvents(kFALSE), fOnlyBanks(kFALSE), + fDelayedType(-1), fClockChan(-1), fLastClock(0), fClockOverflows(0) { fRocSet.clear(); fModuleSet.clear(); scal_prev_read.clear(); @@ -90,100 +87,94 @@ THcScalerEvtHandler::THcScalerEvtHandler(const char *name, const char* descripti scal_overflows.clear(); } -THcScalerEvtHandler::~THcScalerEvtHandler() -{ +THcScalerEvtHandler::~THcScalerEvtHandler() { // The tree object is owned by ROOT since it gets associated wth the output - // file, so DO NOT delete it here. + // file, so DO NOT delete it here. if (!TROOT::Initialized()) { delete fScalerTree; } Podd::DeleteContainer(scalers); Podd::DeleteContainer(scalerloc); - delete [] dvars_prev_read; - delete [] dvars; - delete [] dvarsFirst; - delete [] fBCM_Gain; - delete [] fBCM_Offset; - delete [] fBCM_SatOffset; - delete [] fBCM_SatQuadratic; - delete [] fBCM_delta_charge; - - for( vector<UInt_t*>::iterator it = fDelayedEvents.begin(); - it != fDelayedEvents.end(); ++it ) - delete [] *it; + delete[] dvars_prev_read; + delete[] dvars; + delete[] dvarsFirst; + delete[] fBCM_Gain; + delete[] fBCM_Offset; + delete[] fBCM_SatOffset; + delete[] fBCM_SatQuadratic; + delete[] fBCM_delta_charge; + + for (vector<UInt_t*>::iterator it = fDelayedEvents.begin(); it != fDelayedEvents.end(); ++it) + delete[] * it; fDelayedEvents.clear(); } -Int_t THcScalerEvtHandler::End( THaRunBase* ) -{ +Int_t THcScalerEvtHandler::End(THaRunBase*) { // Process any delayed events in order received - cout << "THcScalerEvtHandler::End Analyzing " << fDelayedEvents.size() << " delayed scaler events" << endl; - for(std::vector<UInt_t*>::iterator it = fDelayedEvents.begin(); - it != fDelayedEvents.end(); ++it) { + _param_logger->info("THcScalerEvtHandler::End Analyzing {} delayed scaler events", + fDelayedEvents.size()); + + for (std::vector<UInt_t*>::iterator it = fDelayedEvents.begin(); it != fDelayedEvents.end(); + ++it) { UInt_t* rdata = *it; - AnalyzeBuffer(rdata,kFALSE); + AnalyzeBuffer(rdata, kFALSE); } - if (fDebugFile) *fDebugFile << "scaler tree ptr "<<fScalerTree<<endl; - evNumberR = -1; - if (fScalerTree) fScalerTree->Fill(); - - for( vector<UInt_t*>::iterator it = fDelayedEvents.begin(); - it != fDelayedEvents.end(); ++it ) - delete [] *it; + if (fDebugFile) + *fDebugFile << "scaler tree ptr " << fScalerTree << endl; + evNumberR = -1; + if (fScalerTree) + fScalerTree->Fill(); + + for (vector<UInt_t*>::iterator it = fDelayedEvents.begin(); it != fDelayedEvents.end(); ++it) + delete[] * it; fDelayedEvents.clear(); - if (fScalerTree) fScalerTree->Write(); + if (fScalerTree) + fScalerTree->Write(); return 0; } - -Int_t THcScalerEvtHandler::ReadDatabase(const TDatime& date ) -{ +Int_t THcScalerEvtHandler::ReadDatabase(const TDatime& date) { char prefix[2]; - prefix[0]='g'; - prefix[1]='\0'; - fNumBCMs = 0; - DBRequest list[]={ - {"NumBCMs",&fNumBCMs, kInt, 0, 1}, - {0} - }; + prefix[0] = 'g'; + prefix[1] = '\0'; + fNumBCMs = 0; + DBRequest list[] = {{"NumBCMs", &fNumBCMs, kInt, 0, 1}, {0}}; gHcParms->LoadParmValues((DBRequest*)&list, prefix); - //cout << " NUmber of BCMs = " << fNumBCMs << endl; + // cout << " NUmber of BCMs = " << fNumBCMs << endl; // - if(fNumBCMs > 0) { - fBCM_Gain = new Double_t[fNumBCMs]; - fBCM_Offset = new Double_t[fNumBCMs]; - fBCM_SatOffset = new Double_t[fNumBCMs]; + if (fNumBCMs > 0) { + fBCM_Gain = new Double_t[fNumBCMs]; + fBCM_Offset = new Double_t[fNumBCMs]; + fBCM_SatOffset = new Double_t[fNumBCMs]; fBCM_SatQuadratic = new Double_t[fNumBCMs]; - fBCM_delta_charge= new Double_t[fNumBCMs]; - string bcm_namelist; - DBRequest list2[]={ - {"BCM_Gain", fBCM_Gain, kDouble, (UInt_t) fNumBCMs}, - {"BCM_Offset", fBCM_Offset, kDouble,(UInt_t) fNumBCMs}, - {"BCM_SatQuadratic", fBCM_SatQuadratic, kDouble,(UInt_t) fNumBCMs,1}, - {"BCM_SatOffset", fBCM_SatOffset, kDouble,(UInt_t) fNumBCMs,1}, - {"BCM_Names", &bcm_namelist, kString}, - {"BCM_Current_threshold", &fbcm_Current_Threshold, kDouble,0, 1}, - {"BCM_Current_threshold_index", &fbcm_Current_Threshold_Index, kInt,0,1}, - {0} - }; - fbcm_Current_Threshold = 0.0; + fBCM_delta_charge = new Double_t[fNumBCMs]; + string bcm_namelist; + DBRequest list2[] = {{"BCM_Gain", fBCM_Gain, kDouble, (UInt_t)fNumBCMs}, + {"BCM_Offset", fBCM_Offset, kDouble, (UInt_t)fNumBCMs}, + {"BCM_SatQuadratic", fBCM_SatQuadratic, kDouble, (UInt_t)fNumBCMs, 1}, + {"BCM_SatOffset", fBCM_SatOffset, kDouble, (UInt_t)fNumBCMs, 1}, + {"BCM_Names", &bcm_namelist, kString}, + {"BCM_Current_threshold", &fbcm_Current_Threshold, kDouble, 0, 1}, + {"BCM_Current_threshold_index", &fbcm_Current_Threshold_Index, kInt, 0, 1}, + {0}}; + fbcm_Current_Threshold = 0.0; fbcm_Current_Threshold_Index = 0; - for(Int_t i=0;i<fNumBCMs;i++) { - fBCM_SatOffset[i]=0.; - fBCM_SatQuadratic[i]=0.; + for (Int_t i = 0; i < fNumBCMs; i++) { + fBCM_SatOffset[i] = 0.; + fBCM_SatQuadratic[i] = 0.; } gHcParms->LoadParmValues((DBRequest*)&list2, prefix); vector<string> bcm_names = vsplit(bcm_namelist); - for(Int_t i=0;i<fNumBCMs;i++) { - fBCM_Name.push_back(bcm_names[i]+".scal"); - fBCM_delta_charge[i]=0.; + for (Int_t i = 0; i < fNumBCMs; i++) { + fBCM_Name.push_back(bcm_names[i] + ".scal"); + fBCM_delta_charge[i] = 0.; } } - fTotalTime=0.; - fPrevTotalTime=0.; - fDeltaTime=-1.; + fTotalTime = 0.; + fPrevTotalTime = 0.; + fDeltaTime = -1.; // // return kOK; @@ -199,22 +190,22 @@ void THcScalerEvtHandler::SetDelayedType(int evtype) { */ fDelayedType = evtype; } - -Int_t THcScalerEvtHandler::Analyze(THaEvData *evdata) -{ - Int_t lfirst=1; - if ( !IsMyEvent(evdata->GetEvType()) ) return -1; +Int_t THcScalerEvtHandler::Analyze(THaEvData* evdata) { + Int_t lfirst = 1; + + if (!IsMyEvent(evdata->GetEvType())) + return -1; if (fDebugFile) { - *fDebugFile << endl << "---------------------------------- "<<endl<<endl; - *fDebugFile << "\nEnter THcScalerEvtHandler for fName = "<<fName<<endl; + *fDebugFile << endl << "---------------------------------- " << endl << endl; + *fDebugFile << "\nEnter THcScalerEvtHandler for fName = " << fName << endl; EvDump(evdata); } + /// \todo : Put this first event stuff in separte function if (lfirst && !fScalerTree) { - lfirst = 0; // Can't do this in Init for some reason TString sname1 = "TS"; @@ -222,70 +213,73 @@ Int_t THcScalerEvtHandler::Analyze(THaEvData *evdata) TString sname3 = fName + " Scaler Data"; if (fDebugFile) { - *fDebugFile << "\nAnalyze 1st time for fName = "<<fName<<endl; - *fDebugFile << sname2 << " " <<sname3<<endl; + *fDebugFile << "\nAnalyze 1st time for fName = " << fName << endl; + *fDebugFile << sname2 << " " << sname3 << endl; } - fScalerTree = new TTree(sname2.Data(),sname3.Data()); + fScalerTree = new TTree(sname2.Data(), sname3.Data()); fScalerTree->SetAutoSave(200000000); TString name, tinfo; - name = "evcount"; + name = "evcount"; tinfo = name + "/D"; fScalerTree->Branch(name.Data(), &evcountR, tinfo.Data(), 4000); - - name = "evNumber"; + + name = "evNumber"; tinfo = name + "/D"; fScalerTree->Branch(name.Data(), &evNumberR, tinfo.Data(), 4000); for (size_t i = 0; i < scalerloc.size(); i++) { - name = scalerloc[i]->name; + name = scalerloc[i]->name; tinfo = name + "/D"; fScalerTree->Branch(name.Data(), &dvars[i], tinfo.Data(), 4000); } - } // if (lfirst && !fScalerTree) + } // if (lfirst && !fScalerTree) - UInt_t *rdata = (UInt_t*) evdata->GetRawDataBuffer(); + UInt_t* rdata = (UInt_t*)evdata->GetRawDataBuffer(); - if( evdata->GetEvType() == fDelayedType) { // Save this event for processing later + if (evdata->GetEvType() == fDelayedType) { // Save this event for processing later Int_t evlen = evdata->GetEvLength(); - - UInt_t *datacopy = new UInt_t[evlen]; + + UInt_t* datacopy = new UInt_t[evlen]; fDelayedEvents.push_back(datacopy); - memcpy(datacopy,rdata,evlen*sizeof(UInt_t)); + memcpy(datacopy, rdata, evlen * sizeof(UInt_t)); return 1; - } else { // A normal event - if (fDebugFile) *fDebugFile<<"\n\nTHcScalerEvtHandler :: Debugging event type "<<dec<<evdata->GetEvType()<< " event num = " << evdata->GetEvNum() << endl<<endl; - evNumber=evdata->GetEvNum(); + } else { // A normal event + if (fDebugFile) + *fDebugFile << "\n\nTHcScalerEvtHandler :: Debugging event type " << dec + << evdata->GetEvType() << " event num = " << evdata->GetEvNum() << endl + << endl; + evNumber = evdata->GetEvNum(); evNumberR = evNumber; Int_t ret; - if((ret=AnalyzeBuffer(rdata,fOnlySyncEvents))) { - if (fDebugFile) *fDebugFile << "scaler tree ptr "<<fScalerTree<<endl; - if (fScalerTree) fScalerTree->Fill(); + if ((ret = AnalyzeBuffer(rdata, fOnlySyncEvents))) { + if (fDebugFile) + *fDebugFile << "scaler tree ptr " << fScalerTree << endl; + if (fScalerTree) + fScalerTree->Fill(); + fScalerTree->AutoSave("SaveSelf"); } return ret; - } - } -Int_t THcScalerEvtHandler::AnalyzeBuffer(UInt_t* rdata, Bool_t onlysync) -{ +Int_t THcScalerEvtHandler::AnalyzeBuffer(UInt_t* rdata, Bool_t onlysync) { // Parse the data, load local data arrays. - UInt_t *p = (UInt_t*) rdata; + UInt_t* p = (UInt_t*)rdata; - UInt_t *plast = p+*p; // Index to last word in the bank + UInt_t* plast = p + *p; // Index to last word in the bank - ifound=0; - while(p<plast) { - p++; // point to header + ifound = 0; + while (p < plast) { + p++; // point to header if (fDebugFile) { - *fDebugFile << "Bank: " << hex << *p << dec << " len: " << *(p-1) << endl; + *fDebugFile << "Bank: " << hex << *p << dec << " len: " << *(p - 1) << endl; } - if((*p & 0xff00) == 0x1000) { // Bank Containing banks - p++; // Now pointing to a bank in the bank + if ((*p & 0xff00) == 0x1000) { // Bank Containing banks + p++; // Now pointing to a bank in the bank } else if (((*p & 0xff00) == 0x100) && (*p != 0xC0000100)) { // Bank containing integers. Look for scalers // This is either ROC bank containing integers or @@ -294,488 +288,537 @@ Int_t THcScalerEvtHandler::AnalyzeBuffer(UInt_t* rdata, Bool_t onlysync) // Assume that very first word is a scaler header // At any point in the bank where the word is not a matching // header, we stop. - UInt_t tag = (*p>>16) & 0xffff; - UInt_t num = (*p) & 0xff; - UInt_t *pnext = p+*(p-1); // Next bank - p++; // First data word + UInt_t tag = (*p >> 16) & 0xffff; + UInt_t num = (*p) & 0xff; + UInt_t* pnext = p + *(p - 1); // Next bank + p++; // First data word // Skip over banks that can't contain scalers // If SetOnlyBanks(kTRUE) called, fRocSet will be empty // so only bank tags matching module types will be considered. - if(fModuleSet.find(tag)!=fModuleSet.end()) { - if(onlysync && num==0) { - ifound = 0; - return 0; - } - } else if (fRocSet.find(tag)==fRocSet.end()) { - p = pnext; // Fall through to end of the above else if + if (fModuleSet.find(tag) != fModuleSet.end()) { + if (onlysync && num == 0) { + ifound = 0; + return 0; + } + } else if (fRocSet.find(tag) == fRocSet.end()) { + p = pnext; // Fall through to end of the above else if } // Look for normalization scaler module first. - if(fNormIdx >= 0) { - UInt_t *psave = p; - while(p < pnext) { - if(scalers[fNormIdx]->IsSlot(*p)) { - scalers[fNormIdx]->Decode(p); - ifound = 1; - break; - } - p += scalers[fNormIdx]->GetNumChan() + 1; - } - p = psave; + if (fNormIdx >= 0) { + UInt_t* psave = p; + while (p < pnext) { + if (scalers[fNormIdx]->IsSlot(*p)) { + scalers[fNormIdx]->Decode(p); + ifound = 1; + break; + } + p += scalers[fNormIdx]->GetNumChan() + 1; + } + p = psave; } - while(p < pnext) { - Int_t nskip = 0; - if(fDebugFile) { - *fDebugFile << "Scaler Header: " << hex << *p << dec; - } - for(size_t j=0; j<scalers.size(); j++) { - if(scalers[j]->IsSlot(*p)) { - nskip = scalers[j]->GetNumChan() + 1; - if((Int_t) j != fNormIdx) { - if(fDebugFile) { - *fDebugFile << " found (" << j << ") skip " << nskip << endl; - } - scalers[j]->Decode(p); - ifound = 1; - } - break; - } - } - if(nskip == 0) { - if(fDebugFile) { - *fDebugFile << endl; - } - break; // Didn't find a matching header - } - p = p + nskip; + while (p < pnext) { + Int_t nskip = 0; + if (fDebugFile) { + *fDebugFile << "Scaler Header: " << hex << *p << dec; + } + for (size_t j = 0; j < scalers.size(); j++) { + if (scalers[j]->IsSlot(*p)) { + nskip = scalers[j]->GetNumChan() + 1; + if ((Int_t)j != fNormIdx) { + if (fDebugFile) { + *fDebugFile << " found (" << j << ") skip " << nskip << endl; + } + scalers[j]->Decode(p); + ifound = 1; + } + break; + } + } + if (nskip == 0) { + if (fDebugFile) { + *fDebugFile << endl; + } + break; // Didn't find a matching header + } + p = p + nskip; } p = pnext; } else { - p = p+*(p-1); // Skip to next bank + p = p + *(p - 1); // Skip to next bank } } if (fDebugFile) { - *fDebugFile << "Finished with decoding. "<<endl; - *fDebugFile << " Found flag = "<<ifound<<endl; + *fDebugFile << "Finished with decoding. " << endl; + *fDebugFile << " Found flag = " << ifound << endl; } // HMS has headers which are different from SOS, but both are // event type 0 and come here. If you found no headers, return. - if (!ifound) return 0; + if (!ifound) + return 0; // The correspondance between dvars and the scaler and the channel // will be driven by a scaler.map file -- later - Double_t scal_current=0; - UInt_t thisClock = scalers[fNormIdx]->GetData(fClockChan); - if(thisClock < fLastClock) { // Count clock scaler wrap arounds + Double_t scal_current = 0; + UInt_t thisClock = scalers[fNormIdx]->GetData(fClockChan); + if (thisClock < fLastClock) { // Count clock scaler wrap arounds fClockOverflows++; } - fTotalTime = (thisClock+(((Double_t) fClockOverflows)*kMaxUInt+fClockOverflows))/fClockFreq; + fTotalTime = + (thisClock + (((Double_t)fClockOverflows) * kMaxUInt + fClockOverflows)) / fClockFreq; fLastClock = thisClock; - fDeltaTime= fTotalTime - fPrevTotalTime; - if (fDeltaTime==0) { + fDeltaTime = fTotalTime - fPrevTotalTime; + if (fDeltaTime == 0) { cout << " ******************* Severe Warning ****************************" << endl; cout << " In THcScalerEvtHandler have found fDeltaTime is zero !! " << endl; - cout << " ******************* Alert DAQ experts ****************************" << endl; + cout << " ******************* Alert DAQ experts ****************************" << endl; } - fPrevTotalTime=fTotalTime; - Int_t nscal=0; - for (size_t i = 0; i < scalerloc.size(); i++) { - size_t ivar = scalerloc[i]->ivar; - size_t idx = scalerloc[i]->index; + fPrevTotalTime = fTotalTime; + Int_t nscal = 0; + for (size_t i = 0; i < scalerloc.size(); i++) { + size_t ivar = scalerloc[i]->ivar; + size_t idx = scalerloc[i]->index; size_t ichan = scalerloc[i]->ichan; - if (evcount==0) { - if (fDebugFile) *fDebugFile << "Debug dvarsFirst "<<i<<" "<<ivar<<" "<<idx<<" "<<ichan<<endl; - if ((ivar < scalerloc.size()) && - (idx < scalers.size()) && - (ichan < MAXCHAN)){ - if(fUseFirstEvent){ - if (scalerloc[ivar]->ikind == ICOUNT){ - UInt_t scaldata = scalers[idx]->GetData(ichan); - dvars[ivar] = scaldata; - scal_present_read.push_back(scaldata); - scal_prev_read.push_back(0); - scal_overflows.push_back(0); - dvarsFirst[ivar] = 0.0; - } - if (scalerloc[ivar]->ikind == ITIME){ - dvars[ivar] =fTotalTime; - dvarsFirst[ivar] = 0; - } - if (scalerloc[ivar]->ikind == IRATE) { - dvars[ivar] = (scalers[idx]->GetData(ichan))/fDeltaTime; - dvarsFirst[ivar] = dvars[ivar]; - //printf("%s %f\n",scalerloc[ivar]->name.Data(),scalers[idx]->GetRate(ichan)); //checks - } - if(scalerloc[ivar]->ikind == ICURRENT || scalerloc[ivar]->ikind == ICHARGE){ - Int_t bcm_ind=-1; - for(Int_t itemp =0; itemp<fNumBCMs;itemp++) - { - size_t match = string(scalerloc[ivar]->name.Data()).find(string(fBCM_Name[itemp])); - if (match!=string::npos) - { - bcm_ind=itemp; - } - } - if (scalerloc[ivar]->ikind == ICURRENT) { - dvars[ivar]=0.; - if (bcm_ind != -1) { - dvars[ivar]=((scalers[idx]->GetData(ichan))/fDeltaTime-fBCM_Offset[bcm_ind])/fBCM_Gain[bcm_ind]; - dvars[ivar]=dvars[ivar]+fBCM_SatOffset[bcm_ind]*TMath::Max(dvars[ivar]-fBCM_SatOffset[i],0.0); - } - if (bcm_ind == fbcm_Current_Threshold_Index) scal_current= dvars[ivar]; - } - if (scalerloc[ivar]->ikind == ICHARGE) { - if (bcm_ind != -1) { - Double_t cur_temp=((scalers[idx]->GetData(ichan))/fDeltaTime-fBCM_Offset[bcm_ind])/fBCM_Gain[bcm_ind]; - cur_temp=cur_temp+fBCM_SatQuadratic[bcm_ind]*TMath::Power(TMath::Max(cur_temp-fBCM_SatOffset[bcm_ind],0.0),2.0); - fBCM_delta_charge[bcm_ind]=fDeltaTime*cur_temp; - dvars[ivar]+=fBCM_delta_charge[bcm_ind]; - } - } - // printf("1st event %i index %i fBCMname %s scalerloc %s offset %f gain %f computed %f\n",evcount, bcm_ind, fBCM_Name[bcm_ind],scalerloc[ivar]->name.Data(),fBCM_Offset[bcm_ind],fBCM_Gain[bcm_ind],dvars[ivar]); - } - - if (fDebugFile) *fDebugFile << " dvarsFirst "<<scalerloc[ivar]->ikind<<" "<<dvarsFirst[ivar]<<endl; - - } else { //ifnotusefirstevent - if (scalerloc[ivar]->ikind == ICOUNT) { - dvarsFirst[ivar] = scalers[idx]->GetData(ichan) ; - scal_present_read.push_back(dvarsFirst[ivar]); - scal_prev_read.push_back(0); - } - if (scalerloc[ivar]->ikind == ITIME){ - dvarsFirst[ivar] = fTotalTime; - } - if (scalerloc[ivar]->ikind == IRATE) { - dvarsFirst[ivar] = (scalers[idx]->GetData(ichan))/fDeltaTime; - //printf("%s %f\n",scalerloc[ivar]->name.Data(),scalers[idx]->GetRate(ichan)); //checks - } - if(scalerloc[ivar]->ikind == ICURRENT || scalerloc[ivar]->ikind == ICHARGE) - { - Int_t bcm_ind=-1; - for(Int_t itemp =0; itemp<fNumBCMs;itemp++) - { - size_t match = string(scalerloc[ivar]->name.Data()).find(string(fBCM_Name[itemp])); - if (match!=string::npos) - { - bcm_ind=itemp; - } - } - if (scalerloc[ivar]->ikind == ICURRENT) { - dvarsFirst[ivar]=0.0; - if (bcm_ind != -1) { - dvarsFirst[ivar]=((scalers[idx]->GetData(ichan))/fDeltaTime-fBCM_Offset[bcm_ind])/fBCM_Gain[bcm_ind]; - dvarsFirst[ivar]=dvarsFirst[ivar]+fBCM_SatQuadratic[bcm_ind]*TMath::Power(TMath::Max(dvars[ivar]-fBCM_SatOffset[i],0.0),2.); - } - if (bcm_ind == fbcm_Current_Threshold_Index) scal_current= dvarsFirst[ivar]; - } - if (scalerloc[ivar]->ikind == ICHARGE) { - if (bcm_ind != -1) { - Double_t cur_temp=((scalers[idx]->GetData(ichan))/fDeltaTime-fBCM_Offset[bcm_ind])/fBCM_Gain[bcm_ind]; - cur_temp=cur_temp+fBCM_SatQuadratic[bcm_ind]*TMath::Power(TMath::Max(cur_temp-fBCM_SatOffset[bcm_ind],0.0),2.); - fBCM_delta_charge[bcm_ind]=fDeltaTime*cur_temp; - dvarsFirst[ivar]+=fBCM_delta_charge[bcm_ind]; - } - } - } - if (fDebugFile) *fDebugFile << " dvarsFirst "<<scalerloc[ivar]->ikind<<" "<<dvarsFirst[ivar]<<endl; - } - } - else { - cout << "THcScalerEvtHandler:: ERROR:: incorrect index "<<ivar<<" "<<idx<<" "<<ichan<<endl; + if (evcount == 0) { + if (fDebugFile) + *fDebugFile << "Debug dvarsFirst " << i << " " << ivar << " " << idx << " " << ichan + << endl; + if ((ivar < scalerloc.size()) && (idx < scalers.size()) && (ichan < MAXCHAN)) { + if (fUseFirstEvent) { + if (scalerloc[ivar]->ikind == ICOUNT) { + UInt_t scaldata = scalers[idx]->GetData(ichan); + dvars[ivar] = scaldata; + scal_present_read.push_back(scaldata); + scal_prev_read.push_back(0); + scal_overflows.push_back(0); + dvarsFirst[ivar] = 0.0; + } + if (scalerloc[ivar]->ikind == ITIME) { + dvars[ivar] = fTotalTime; + dvarsFirst[ivar] = 0; + } + if (scalerloc[ivar]->ikind == IRATE) { + dvars[ivar] = (scalers[idx]->GetData(ichan)) / fDeltaTime; + dvarsFirst[ivar] = dvars[ivar]; + // printf("%s %f\n",scalerloc[ivar]->name.Data(),scalers[idx]->GetRate(ichan)); //checks + } + if (scalerloc[ivar]->ikind == ICURRENT || scalerloc[ivar]->ikind == ICHARGE) { + Int_t bcm_ind = -1; + for (Int_t itemp = 0; itemp < fNumBCMs; itemp++) { + size_t match = string(scalerloc[ivar]->name.Data()).find(string(fBCM_Name[itemp])); + if (match != string::npos) { + bcm_ind = itemp; + } + } + if (scalerloc[ivar]->ikind == ICURRENT) { + dvars[ivar] = 0.; + if (bcm_ind != -1) { + dvars[ivar] = ((scalers[idx]->GetData(ichan)) / fDeltaTime - fBCM_Offset[bcm_ind]) / + fBCM_Gain[bcm_ind]; + dvars[ivar] = + dvars[ivar] + + fBCM_SatOffset[bcm_ind] * TMath::Max(dvars[ivar] - fBCM_SatOffset[i], 0.0); + } + if (bcm_ind == fbcm_Current_Threshold_Index) + scal_current = dvars[ivar]; + } + if (scalerloc[ivar]->ikind == ICHARGE) { + if (bcm_ind != -1) { + Double_t cur_temp = + ((scalers[idx]->GetData(ichan)) / fDeltaTime - fBCM_Offset[bcm_ind]) / + fBCM_Gain[bcm_ind]; + cur_temp = + cur_temp + + fBCM_SatQuadratic[bcm_ind] * + TMath::Power(TMath::Max(cur_temp - fBCM_SatOffset[bcm_ind], 0.0), 2.0); + fBCM_delta_charge[bcm_ind] = fDeltaTime * cur_temp; + dvars[ivar] += fBCM_delta_charge[bcm_ind]; + } + } + // printf("1st event %i index %i fBCMname %s scalerloc %s offset %f gain %f + //computed %f\n",evcount, bcm_ind, + //fBCM_Name[bcm_ind],scalerloc[ivar]->name.Data(),fBCM_Offset[bcm_ind],fBCM_Gain[bcm_ind],dvars[ivar]); + } + + if (fDebugFile) + *fDebugFile << " dvarsFirst " << scalerloc[ivar]->ikind << " " << dvarsFirst[ivar] + << endl; + + } else { // ifnotusefirstevent + if (scalerloc[ivar]->ikind == ICOUNT) { + dvarsFirst[ivar] = scalers[idx]->GetData(ichan); + scal_present_read.push_back(dvarsFirst[ivar]); + scal_prev_read.push_back(0); + } + if (scalerloc[ivar]->ikind == ITIME) { + dvarsFirst[ivar] = fTotalTime; + } + if (scalerloc[ivar]->ikind == IRATE) { + dvarsFirst[ivar] = (scalers[idx]->GetData(ichan)) / fDeltaTime; + // printf("%s %f\n",scalerloc[ivar]->name.Data(),scalers[idx]->GetRate(ichan)); //checks + } + if (scalerloc[ivar]->ikind == ICURRENT || scalerloc[ivar]->ikind == ICHARGE) { + Int_t bcm_ind = -1; + for (Int_t itemp = 0; itemp < fNumBCMs; itemp++) { + size_t match = string(scalerloc[ivar]->name.Data()).find(string(fBCM_Name[itemp])); + if (match != string::npos) { + bcm_ind = itemp; + } + } + if (scalerloc[ivar]->ikind == ICURRENT) { + dvarsFirst[ivar] = 0.0; + if (bcm_ind != -1) { + dvarsFirst[ivar] = + ((scalers[idx]->GetData(ichan)) / fDeltaTime - fBCM_Offset[bcm_ind]) / + fBCM_Gain[bcm_ind]; + dvarsFirst[ivar] = + dvarsFirst[ivar] + + fBCM_SatQuadratic[bcm_ind] * + TMath::Power(TMath::Max(dvars[ivar] - fBCM_SatOffset[i], 0.0), 2.); + } + if (bcm_ind == fbcm_Current_Threshold_Index) + scal_current = dvarsFirst[ivar]; + } + if (scalerloc[ivar]->ikind == ICHARGE) { + if (bcm_ind != -1) { + Double_t cur_temp = + ((scalers[idx]->GetData(ichan)) / fDeltaTime - fBCM_Offset[bcm_ind]) / + fBCM_Gain[bcm_ind]; + cur_temp = + cur_temp + + fBCM_SatQuadratic[bcm_ind] * + TMath::Power(TMath::Max(cur_temp - fBCM_SatOffset[bcm_ind], 0.0), 2.); + fBCM_delta_charge[bcm_ind] = fDeltaTime * cur_temp; + dvarsFirst[ivar] += fBCM_delta_charge[bcm_ind]; + } + } + } + if (fDebugFile) + *fDebugFile << " dvarsFirst " << scalerloc[ivar]->ikind << " " << dvarsFirst[ivar] + << endl; + } + } else { + cout << "THcScalerEvtHandler:: ERROR:: incorrect index " << ivar << " " << idx << " " + << ichan << endl; } - }else{ // evcount != 0 - if (fDebugFile) *fDebugFile << "Debug dvars "<<i<<" "<<ivar<<" "<<idx<<" "<<ichan<<endl; - if ((ivar < scalerloc.size()) && - (idx < scalers.size()) && - (ichan < MAXCHAN)) { - if (scalerloc[ivar]->ikind == ICOUNT) { - UInt_t scaldata = scalers[idx]->GetData(ichan); - if(scaldata < scal_prev_read[nscal]) { - scal_overflows[nscal]++; - } - dvars[ivar] = scaldata + (1+((Double_t)kMaxUInt))*scal_overflows[nscal] - -dvarsFirst[ivar]; - scal_present_read[nscal]=scaldata; - nscal++; - } - if (scalerloc[ivar]->ikind == ITIME) { - dvars[ivar] = fTotalTime; - } - if (scalerloc[ivar]->ikind == IRATE) { - UInt_t scaldata = scalers[idx]->GetData(ichan); - UInt_t diff; - if(scaldata < scal_prev_read[nscal-1]) { - diff = (kMaxUInt-(scal_prev_read[nscal-1] - 1)) + scaldata; - } else { - diff = scaldata - scal_prev_read[nscal-1]; - } - dvars[ivar] = diff/fDeltaTime; - // printf("%s %f\n",scalerloc[ivar]->name.Data(),scalers[idx]->GetRate(ichan));//checks - } - if(scalerloc[ivar]->ikind == ICURRENT || scalerloc[ivar]->ikind == ICHARGE) - { - Int_t bcm_ind=-1; - for(Int_t itemp =0; itemp<fNumBCMs;itemp++) - { - size_t match = string(scalerloc[ivar]->name.Data()).find(string(fBCM_Name[itemp])); - if (match!=string::npos) - { - bcm_ind=itemp; - } - } - if (scalerloc[ivar]->ikind == ICURRENT) { - dvars[ivar]=0; - if (bcm_ind != -1) { - UInt_t scaldata = scalers[idx]->GetData(ichan); - UInt_t diff; - if(scaldata < scal_prev_read[nscal-1]) { - diff = (kMaxUInt-(scal_prev_read[nscal-1] - 1)) + scaldata; - } else { - diff = scaldata - scal_prev_read[nscal-1]; - } - dvars[ivar]=0.; - if (fDeltaTime>0) { - Double_t cur_temp=(diff/fDeltaTime-fBCM_Offset[bcm_ind])/fBCM_Gain[bcm_ind]; - cur_temp=cur_temp+fBCM_SatQuadratic[bcm_ind]*TMath::Power(TMath::Max(cur_temp-fBCM_SatOffset[bcm_ind],0.0),2.); - - dvars[ivar]=cur_temp; - } - } - if (bcm_ind == fbcm_Current_Threshold_Index) scal_current= dvars[ivar]; - } - if (scalerloc[ivar]->ikind == ICHARGE) { - if (bcm_ind != -1) { - UInt_t scaldata = scalers[idx]->GetData(ichan); - UInt_t diff; - if(scaldata < scal_prev_read[nscal-1]) { - diff = (kMaxUInt-(scal_prev_read[nscal-1] - 1)) + scaldata; - } else { - diff = scaldata - scal_prev_read[nscal-1]; - } - fBCM_delta_charge[bcm_ind]=0; - if (fDeltaTime>0) { - Double_t cur_temp=(diff/fDeltaTime-fBCM_Offset[bcm_ind])/fBCM_Gain[bcm_ind]; - cur_temp=cur_temp+fBCM_SatQuadratic[bcm_ind]*TMath::Power(TMath::Max(cur_temp-fBCM_SatOffset[bcm_ind],0.0),2.); - fBCM_delta_charge[bcm_ind]=fDeltaTime*cur_temp; - } - dvars[ivar]+=fBCM_delta_charge[bcm_ind]; - } - } - // printf("event %i index %i fBCMname %s scalerloc %s offset %f gain %f computed %f\n",evcount, bcm_ind, fBCM_Name[bcm_ind],scalerloc[ivar]->name.Data(),fBCM_Offset[bcm_ind],fBCM_Gain[bcm_ind],dvars[ivar]); - } - if (fDebugFile) *fDebugFile << " dvars "<<scalerloc[ivar]->ikind<<" "<<dvars[ivar]<<endl; + } else { // evcount != 0 + if (fDebugFile) + *fDebugFile << "Debug dvars " << i << " " << ivar << " " << idx << " " << ichan << endl; + if ((ivar < scalerloc.size()) && (idx < scalers.size()) && (ichan < MAXCHAN)) { + if (scalerloc[ivar]->ikind == ICOUNT) { + UInt_t scaldata = scalers[idx]->GetData(ichan); + if (scaldata < scal_prev_read[nscal]) { + scal_overflows[nscal]++; + } + dvars[ivar] = + scaldata + (1 + ((Double_t)kMaxUInt)) * scal_overflows[nscal] - dvarsFirst[ivar]; + scal_present_read[nscal] = scaldata; + nscal++; + } + if (scalerloc[ivar]->ikind == ITIME) { + dvars[ivar] = fTotalTime; + } + if (scalerloc[ivar]->ikind == IRATE) { + UInt_t scaldata = scalers[idx]->GetData(ichan); + UInt_t diff; + if (scaldata < scal_prev_read[nscal - 1]) { + diff = (kMaxUInt - (scal_prev_read[nscal - 1] - 1)) + scaldata; + } else { + diff = scaldata - scal_prev_read[nscal - 1]; + } + dvars[ivar] = diff / fDeltaTime; + // printf("%s %f\n",scalerloc[ivar]->name.Data(),scalers[idx]->GetRate(ichan));//checks + } + if (scalerloc[ivar]->ikind == ICURRENT || scalerloc[ivar]->ikind == ICHARGE) { + Int_t bcm_ind = -1; + for (Int_t itemp = 0; itemp < fNumBCMs; itemp++) { + size_t match = string(scalerloc[ivar]->name.Data()).find(string(fBCM_Name[itemp])); + if (match != string::npos) { + bcm_ind = itemp; + } + } + if (scalerloc[ivar]->ikind == ICURRENT) { + dvars[ivar] = 0; + if (bcm_ind != -1) { + UInt_t scaldata = scalers[idx]->GetData(ichan); + UInt_t diff; + if (scaldata < scal_prev_read[nscal - 1]) { + diff = (kMaxUInt - (scal_prev_read[nscal - 1] - 1)) + scaldata; + } else { + diff = scaldata - scal_prev_read[nscal - 1]; + } + dvars[ivar] = 0.; + if (fDeltaTime > 0) { + Double_t cur_temp = (diff / fDeltaTime - fBCM_Offset[bcm_ind]) / fBCM_Gain[bcm_ind]; + cur_temp = + cur_temp + + fBCM_SatQuadratic[bcm_ind] * + TMath::Power(TMath::Max(cur_temp - fBCM_SatOffset[bcm_ind], 0.0), 2.); + + dvars[ivar] = cur_temp; + } + } + if (bcm_ind == fbcm_Current_Threshold_Index) + scal_current = dvars[ivar]; + } + if (scalerloc[ivar]->ikind == ICHARGE) { + if (bcm_ind != -1) { + UInt_t scaldata = scalers[idx]->GetData(ichan); + UInt_t diff; + if (scaldata < scal_prev_read[nscal - 1]) { + diff = (kMaxUInt - (scal_prev_read[nscal - 1] - 1)) + scaldata; + } else { + diff = scaldata - scal_prev_read[nscal - 1]; + } + fBCM_delta_charge[bcm_ind] = 0; + if (fDeltaTime > 0) { + Double_t cur_temp = (diff / fDeltaTime - fBCM_Offset[bcm_ind]) / fBCM_Gain[bcm_ind]; + cur_temp = + cur_temp + + fBCM_SatQuadratic[bcm_ind] * + TMath::Power(TMath::Max(cur_temp - fBCM_SatOffset[bcm_ind], 0.0), 2.); + fBCM_delta_charge[bcm_ind] = fDeltaTime * cur_temp; + } + dvars[ivar] += fBCM_delta_charge[bcm_ind]; + } + } + // printf("event %i index %i fBCMname %s scalerloc %s offset %f gain %f computed + //%f\n",evcount, bcm_ind, + //fBCM_Name[bcm_ind],scalerloc[ivar]->name.Data(),fBCM_Offset[bcm_ind],fBCM_Gain[bcm_ind],dvars[ivar]); + } + if (fDebugFile) + *fDebugFile << " dvars " << scalerloc[ivar]->ikind << " " << dvars[ivar] << endl; } else { - cout << "THcScalerEvtHandler:: ERROR:: incorrect index "<<ivar<<" "<<idx<<" "<<ichan<<endl; + cout << "THcScalerEvtHandler:: ERROR:: incorrect index " << ivar << " " << idx << " " + << ichan << endl; } } - } // - for (size_t i = 0; i < scalerloc.size(); i++) { - size_t ivar = scalerloc[i]->ivar; - size_t idx = scalerloc[i]->index; + for (size_t i = 0; i < scalerloc.size(); i++) { + size_t ivar = scalerloc[i]->ivar; + size_t idx = scalerloc[i]->index; size_t ichan = scalerloc[i]->ichan; - if (scalerloc[ivar]->ikind == ICUT+ICOUNT){ + if (scalerloc[ivar]->ikind == ICUT + ICOUNT) { UInt_t scaldata = scalers[idx]->GetData(ichan); - if ( scal_current > fbcm_Current_Threshold) { - UInt_t diff; - if(scaldata < dvars_prev_read[ivar]) { - diff = (kMaxUInt-(dvars_prev_read[ivar] - 1)) + scaldata; - } else { - diff = scaldata - dvars_prev_read[ivar]; - } - dvars[ivar] += diff; - } + if (scal_current > fbcm_Current_Threshold) { + UInt_t diff; + if (scaldata < dvars_prev_read[ivar]) { + diff = (kMaxUInt - (dvars_prev_read[ivar] - 1)) + scaldata; + } else { + diff = scaldata - dvars_prev_read[ivar]; + } + dvars[ivar] += diff; + } dvars_prev_read[ivar] = scaldata; } - if (scalerloc[ivar]->ikind == ICUT+ICHARGE){ - Int_t bcm_ind=-1; - for(Int_t itemp =0; itemp<fNumBCMs;itemp++) - { - size_t match = string(scalerloc[ivar]->name.Data()).find(string(fBCM_Name[itemp])); - if (match!=string::npos) - { - bcm_ind=itemp; - } - } - if ( scal_current > fbcm_Current_Threshold && bcm_ind != -1) { - dvars[ivar] += fBCM_delta_charge[bcm_ind]; - } + if (scalerloc[ivar]->ikind == ICUT + ICHARGE) { + Int_t bcm_ind = -1; + for (Int_t itemp = 0; itemp < fNumBCMs; itemp++) { + size_t match = string(scalerloc[ivar]->name.Data()).find(string(fBCM_Name[itemp])); + if (match != string::npos) { + bcm_ind = itemp; + } + } + if (scal_current > fbcm_Current_Threshold && bcm_ind != -1) { + dvars[ivar] += fBCM_delta_charge[bcm_ind]; + } } - if (scalerloc[ivar]->ikind == ICUT+ITIME){ - if ( scal_current > fbcm_Current_Threshold) { - dvars[ivar] += fDeltaTime; - } + if (scalerloc[ivar]->ikind == ICUT + ITIME) { + if (scal_current > fbcm_Current_Threshold) { + dvars[ivar] += fDeltaTime; + } } } // - evcount = evcount + 1; + evcount = evcount + 1; evcountR = evcount; // - for (size_t j=0; j<scal_prev_read.size(); j++) scal_prev_read[j]=scal_present_read[j]; - // - for (size_t j=0; j<scalers.size(); j++) scalers[j]->Clear(""); - + for (size_t j = 0; j < scal_prev_read.size(); j++) + scal_prev_read[j] = scal_present_read[j]; + // + for (size_t j = 0; j < scalers.size(); j++) + scalers[j]->Clear(""); + return 1; } - -THaAnalysisObject::EStatus THcScalerEvtHandler::Init(const TDatime& date) -{ +THaAnalysisObject::EStatus THcScalerEvtHandler::Init(const TDatime& date) { // ReadDatabase(date); const int LEN = 200; - char cbuf[LEN]; + char cbuf[LEN]; - fStatus = kOK; + fStatus = kOK; fNormIdx = -1; - for( vector<UInt_t*>::iterator it = fDelayedEvents.begin(); - it != fDelayedEvents.end(); ++it ) - delete [] *it; + for (vector<UInt_t*>::iterator it = fDelayedEvents.begin(); it != fDelayedEvents.end(); ++it) + delete[] * it; fDelayedEvents.clear(); - cout << "Howdy ! We are initializing THcScalerEvtHandler !! name = " - << fName << endl; + // cout << "Howdy ! We are initializing THcScalerEvtHandler !! name = " + // << fName << endl; - if(eventtypes.size()==0) { - eventtypes.push_back(0); // Default Event Type + if (eventtypes.size() == 0) { + eventtypes.push_back(0); // Default Event Type } TString dfile; dfile = fName + "scaler.txt"; -// Parse the map file which defines what scalers exist and the global variables. + // Parse the map file which defines what scalers exist and the global variables. TString sname0 = "Scalevt"; TString sname; - sname = fName+sname0; + sname = fName + sname0; - FILE *fi = OpenFile(sname.Data(), date); - if ( !fi ) { - cout << "Cannot find db file for "<<fName<<" scaler event handler"<<endl; + FILE* fi = OpenFile(sname.Data(), date); + if (!fi) { + cout << "Cannot find db file for " << fName << " scaler event handler" << endl; return kFileError; } - size_t minus1 = -1; - size_t pos1; - string scomment = "#"; - string svariable = "variable"; - string smap = "map"; + size_t minus1 = -1; + size_t pos1; + string scomment = "#"; + string svariable = "variable"; + string smap = "map"; vector<string> dbline; - while( fgets(cbuf, LEN, fi) != NULL) { + while (fgets(cbuf, LEN, fi) != NULL) { std::string sin(cbuf); - std::string sinput(sin.substr(0,sin.find_first_of("#"))); - if (fDebugFile) *fDebugFile << "string input "<<sinput<<endl; + std::string sinput(sin.substr(0, sin.find_first_of("#"))); + if (fDebugFile) + *fDebugFile << "string input " << sinput << endl; dbline = vsplit(sinput); if (dbline.size() > 0) { - pos1 = FindNoCase(dbline[0],scomment); - if (pos1 != minus1) continue; - pos1 = FindNoCase(dbline[0],svariable); - if (pos1 != minus1 && dbline.size()>4) { - string sdesc = ""; - for (size_t j=5; j<dbline.size(); j++) sdesc = sdesc+" "+dbline[j]; - UInt_t islot = atoi(dbline[1].c_str()); - UInt_t ichan = atoi(dbline[2].c_str()); - UInt_t ikind = atoi(dbline[3].c_str()); - if (fDebugFile) - *fDebugFile << "add var "<<dbline[1]<<" desc = "<<sdesc<<" islot= "<<islot<<" "<<ichan<<" "<<ikind<<endl; - TString tsname(dbline[4].c_str()); - TString tsdesc(sdesc.c_str()); - AddVars(tsname,tsdesc,islot,ichan,ikind); - // add extra scaler which is cut on the current - if (ikind == ICOUNT ||ikind == ITIME ||ikind == ICHARGE ) { - tsname=tsname+"Cut"; - AddVars(tsname,tsdesc,islot,ichan,ICUT+ikind); - } + pos1 = FindNoCase(dbline[0], scomment); + if (pos1 != minus1) + continue; + pos1 = FindNoCase(dbline[0], svariable); + if (pos1 != minus1 && dbline.size() > 4) { + string sdesc = ""; + for (size_t j = 5; j < dbline.size(); j++) + sdesc = sdesc + " " + dbline[j]; + UInt_t islot = atoi(dbline[1].c_str()); + UInt_t ichan = atoi(dbline[2].c_str()); + UInt_t ikind = atoi(dbline[3].c_str()); + if (fDebugFile) + *fDebugFile << "add var " << dbline[1] << " desc = " << sdesc << " islot= " << islot + << " " << ichan << " " << ikind << endl; + TString tsname(dbline[4].c_str()); + TString tsdesc(sdesc.c_str()); + AddVars(tsname, tsdesc, islot, ichan, ikind); + // add extra scaler which is cut on the current + if (ikind == ICOUNT || ikind == ITIME || ikind == ICHARGE) { + tsname = tsname + "Cut"; + AddVars(tsname, tsdesc, islot, ichan, ICUT + ikind); + } } - pos1 = FindNoCase(dbline[0],smap); - if (fDebugFile) *fDebugFile << "map ? "<<dbline[0]<<" "<<smap<<" "<<pos1<<" "<<dbline.size()<<endl; - if (pos1 != minus1 && dbline.size()>6) { - Int_t imodel, icrate, islot, inorm; - UInt_t header, mask; - char cdum[20]; - sscanf(sinput.c_str(),"%s %d %d %d %x %x %d \n",cdum,&imodel,&icrate,&islot, &header, &mask, &inorm); - if ((fNormSlot >= 0) && (fNormSlot != inorm)) cout << "THcScalerEvtHandler::WARN: contradictory norm slot "<<fNormSlot<<" "<<inorm<<endl; - fNormSlot = inorm; // slot number used for normalization. This variable is not used but is checked. - Int_t clkchan = -1; - Double_t clkfreq = 1; - if (dbline.size()>8) { - clkchan = atoi(dbline[7].c_str()); - clkfreq = 1.0*atoi(dbline[8].c_str()); - fClockChan=clkchan; - fClockFreq=clkfreq; - } - if (fDebugFile) { - *fDebugFile << "map line "<<dec<<imodel<<" "<<icrate<<" "<<islot<<endl; - *fDebugFile <<" header 0x"<<hex<<header<<" 0x"<<mask<<dec<<" "<<inorm<<" "<<clkchan<<" "<<clkfreq<<endl; - } - switch (imodel) { - case 560: - scalers.push_back(new Scaler560(icrate, islot)); - if(!fOnlyBanks) fRocSet.insert(icrate); - fModuleSet.insert(imodel); - break; - case 1151: - scalers.push_back(new Scaler1151(icrate, islot)); - if(!fOnlyBanks) fRocSet.insert(icrate); - fModuleSet.insert(imodel); - break; - case 3800: - scalers.push_back(new Scaler3800(icrate, islot)); - if(!fOnlyBanks) fRocSet.insert(icrate); - fModuleSet.insert(imodel); - break; - case 3801: - scalers.push_back(new Scaler3801(icrate, islot)); - if(!fOnlyBanks) fRocSet.insert(icrate); - fModuleSet.insert(imodel); - break; - case 9001: // TI Scalers - scalers.push_back(new Scaler9001(icrate, islot)); - if(!fOnlyBanks) fRocSet.insert(icrate); - fModuleSet.insert(imodel); - break; - case 9250: // FADC250 Scalers - scalers.push_back(new Scaler9250(icrate, islot)); - if(!fOnlyBanks) fRocSet.insert(icrate); - fModuleSet.insert(imodel); - break; - } - if (scalers.size() > 0) { - UInt_t idx = scalers.size()-1; - // Headers must be unique over whole event, not - // just within a ROC - scalers[idx]->SetHeader(header, mask); -// The normalization slot has the clock in it, so we automatically recognize it. -// fNormIdx is the index in scaler[] and -// fNormSlot is the slot#, checked for consistency - if (clkchan >= 0) { - scalers[idx]->SetClock(defaultDT, clkchan, clkfreq); - cout << "Setting scaler clock ... channel = "<<clkchan<<" ... freq = "<<clkfreq<<endl; - if (fDebugFile) *fDebugFile <<"Setting scaler clock ... channel = "<<clkchan<<" ... freq = "<<clkfreq<<endl; - fNormIdx = idx; - if (islot != fNormSlot) cout << "THcScalerEvtHandler:: WARN: contradictory norm slot ! "<<islot<<endl; - - } - } + pos1 = FindNoCase(dbline[0], smap); + if (fDebugFile) + *fDebugFile << "map ? " << dbline[0] << " " << smap << " " << pos1 << " " + << dbline.size() << endl; + if (pos1 != minus1 && dbline.size() > 6) { + Int_t imodel, icrate, islot, inorm; + UInt_t header, mask; + char cdum[20]; + sscanf(sinput.c_str(), "%s %d %d %d %x %x %d \n", cdum, &imodel, &icrate, &islot, &header, + &mask, &inorm); + if ((fNormSlot >= 0) && (fNormSlot != inorm)) + cout << "THcScalerEvtHandler::WARN: contradictory norm slot " << fNormSlot << " " + << inorm << endl; + fNormSlot = + inorm; // slot number used for normalization. This variable is not used but is checked. + Int_t clkchan = -1; + Double_t clkfreq = 1; + if (dbline.size() > 8) { + clkchan = atoi(dbline[7].c_str()); + clkfreq = 1.0 * atoi(dbline[8].c_str()); + fClockChan = clkchan; + fClockFreq = clkfreq; + } + if (fDebugFile) { + *fDebugFile << "map line " << dec << imodel << " " << icrate << " " << islot << endl; + *fDebugFile << " header 0x" << hex << header << " 0x" << mask << dec << " " << inorm + << " " << clkchan << " " << clkfreq << endl; + } + switch (imodel) { + case 560: + scalers.push_back(new Scaler560(icrate, islot)); + if (!fOnlyBanks) + fRocSet.insert(icrate); + fModuleSet.insert(imodel); + break; + case 1151: + scalers.push_back(new Scaler1151(icrate, islot)); + if (!fOnlyBanks) + fRocSet.insert(icrate); + fModuleSet.insert(imodel); + break; + case 3800: + scalers.push_back(new Scaler3800(icrate, islot)); + if (!fOnlyBanks) + fRocSet.insert(icrate); + fModuleSet.insert(imodel); + break; + case 3801: + scalers.push_back(new Scaler3801(icrate, islot)); + if (!fOnlyBanks) + fRocSet.insert(icrate); + fModuleSet.insert(imodel); + break; + case 9001: // TI Scalers + scalers.push_back(new Scaler9001(icrate, islot)); + if (!fOnlyBanks) + fRocSet.insert(icrate); + fModuleSet.insert(imodel); + break; + case 9250: // FADC250 Scalers + scalers.push_back(new Scaler9250(icrate, islot)); + if (!fOnlyBanks) + fRocSet.insert(icrate); + fModuleSet.insert(imodel); + break; + } + if (scalers.size() > 0) { + UInt_t idx = scalers.size() - 1; + // Headers must be unique over whole event, not + // just within a ROC + scalers[idx]->SetHeader(header, mask); + // The normalization slot has the clock in it, so we automatically recognize it. + // fNormIdx is the index in scaler[] and + // fNormSlot is the slot#, checked for consistency + if (clkchan >= 0) { + scalers[idx]->SetClock(defaultDT, clkchan, clkfreq); + _param_logger->info("Setting scaler clock ... channel = {} ... freq = {} ", clkchan, + clkfreq); + if (fDebugFile) + *fDebugFile << "Setting scaler clock ... channel = " << clkchan + << " ... freq = " << clkfreq << endl; + fNormIdx = idx; + if (islot != fNormSlot) + cout << "THcScalerEvtHandler:: WARN: contradictory norm slot ! " << islot << endl; + } + } } } } // can't compare UInt_t to Int_t (compiler warning), so do this - nscalers=0; - for (size_t i=0; i<scalers.size(); i++) nscalers++; + nscalers = 0; + for (size_t i = 0; i < scalers.size(); i++) + nscalers++; // need to do LoadNormScaler after scalers created and if fNormIdx found - if (fDebugFile) *fDebugFile <<"fNormIdx = "<<fNormIdx<<endl; + if (fDebugFile) + *fDebugFile << "fNormIdx = " << fNormIdx << endl; if ((fNormIdx >= 0) && fNormIdx < nscalers) { for (Int_t i = 0; i < nscalers; i++) { - if (i==fNormIdx) continue; + if (i == fNormIdx) + continue; scalers[i]->LoadNormScaler(scalers[fNormIdx]); } } @@ -784,27 +827,26 @@ THaAnalysisObject::EStatus THcScalerEvtHandler::Init(const TDatime& date) // This code is superseded by the parsing of a map file above. It's another way ... if (fName == "Left") { AddVars("TSbcmu1", "BCM x1 counts", 1, 4, ICOUNT); - AddVars("TSbcmu1r","BCM x1 rate", 1, 4, IRATE); + AddVars("TSbcmu1r", "BCM x1 rate", 1, 4, IRATE); AddVars("TSbcmu3", "BCM u3 counts", 1, 5, ICOUNT); - AddVars("TSbcmu3r", "BCM u3 rate", 1, 5, IRATE); + AddVars("TSbcmu3r", "BCM u3 rate", 1, 5, IRATE); } else { AddVars("TSbcmu1", "BCM x1 counts", 0, 4, ICOUNT); - AddVars("TSbcmu1r","BCM x1 rate", 0, 4, IRATE); + AddVars("TSbcmu1r", "BCM x1 rate", 0, 4, IRATE); AddVars("TSbcmu3", "BCM u3 counts", 0, 5, ICOUNT); - AddVars("TSbcmu3r", "BCM u3 rate", 0, 5, IRATE); + AddVars("TSbcmu3r", "BCM u3 rate", 0, 5, IRATE); } #endif - DefVars(); #ifdef HARDCODED // This code is superseded by the parsing of a map file above. It's another way ... if (fName == "Left") { - scalers.push_back(new Scaler1151(1,0)); - scalers.push_back(new Scaler3800(1,1)); - scalers.push_back(new Scaler3800(1,2)); - scalers.push_back(new Scaler3800(1,3)); + scalers.push_back(new Scaler1151(1, 0)); + scalers.push_back(new Scaler3800(1, 1)); + scalers.push_back(new Scaler3800(1, 2)); + scalers.push_back(new Scaler3800(1, 3)); scalers[0]->SetHeader(0xabc00000, 0xffff0000); scalers[1]->SetHeader(0xabc10000, 0xffff0000); scalers[2]->SetHeader(0xabc20000, 0xffff0000); @@ -814,10 +856,10 @@ THaAnalysisObject::EStatus THcScalerEvtHandler::Init(const TDatime& date) scalers[2]->LoadNormScaler(scalers[1]); scalers[3]->LoadNormScaler(scalers[1]); } else { - scalers.push_back(new Scaler3800(2,0)); - scalers.push_back(new Scaler3800(2,0)); - scalers.push_back(new Scaler1151(2,1)); - scalers.push_back(new Scaler1151(2,2)); + scalers.push_back(new Scaler3800(2, 0)); + scalers.push_back(new Scaler3800(2, 0)); + scalers.push_back(new Scaler1151(2, 1)); + scalers.push_back(new Scaler1151(2, 2)); scalers[0]->SetHeader(0xceb00000, 0xffff0000); scalers[1]->SetHeader(0xceb10000, 0xffff0000); scalers[2]->SetHeader(0xceb20000, 0xffff0000); @@ -830,88 +872,87 @@ THaAnalysisObject::EStatus THcScalerEvtHandler::Init(const TDatime& date) #endif // Verify that the slots are not defined twice - for (UInt_t i1=0; i1 < scalers.size()-1; i1++) { - for (UInt_t i2=i1+1; i2 < scalers.size(); i2++) { - if (scalers[i1]->GetSlot()==scalers[i2]->GetSlot()) - cout << "THcScalerEvtHandler:: WARN: same slot defined twice"<<endl; + for (UInt_t i1 = 0; i1 < scalers.size() - 1; i1++) { + for (UInt_t i2 = i1 + 1; i2 < scalers.size(); i2++) { + if (scalers[i1]->GetSlot() == scalers[i2]->GetSlot()) + cout << "THcScalerEvtHandler:: WARN: same slot defined twice" << endl; } } // Identify indices of scalers[] vector to variables. - for (UInt_t i=0; i < scalers.size(); i++) { + for (UInt_t i = 0; i < scalers.size(); i++) { for (UInt_t j = 0; j < scalerloc.size(); j++) { - if (scalerloc[j]->islot==static_cast<UInt_t>(scalers[i]->GetSlot())) - scalerloc[j]->index = i; + if (scalerloc[j]->islot == static_cast<UInt_t>(scalers[i]->GetSlot())) + scalerloc[j]->index = i; } } - if(fDebugFile) *fDebugFile << "THcScalerEvtHandler:: Name of scaler bank "<<fName<<endl; - for (size_t i=0; i<scalers.size(); i++) { - if(fDebugFile) { - *fDebugFile << "Scaler # "<<i<<endl; + if (fDebugFile) + *fDebugFile << "THcScalerEvtHandler:: Name of scaler bank " << fName << endl; + for (size_t i = 0; i < scalers.size(); i++) { + if (fDebugFile) { + *fDebugFile << "Scaler # " << i << endl; scalers[i]->SetDebugFile(fDebugFile); scalers[i]->DebugPrint(fDebugFile); } } - // return kOK; } -void THcScalerEvtHandler::AddVars(TString name, TString desc, UInt_t islot, - UInt_t ichan, UInt_t ikind) -{ +void THcScalerEvtHandler::AddVars(TString name, TString desc, UInt_t islot, UInt_t ichan, + UInt_t ikind) { // need to add fName here to make it a unique variable. (Left vs Right HRS, for example) TString name1 = fName + name; TString desc1 = fName + desc; // We don't yet know the correspondence between index of scalers[] and slots. // Will put that in later. - scalerloc.push_back( new HCScalerLoc(name1, desc1, 0, islot, ichan, ikind, - scalerloc.size()) ); + scalerloc.push_back(new HCScalerLoc(name1, desc1, 0, islot, ichan, ikind, scalerloc.size())); } -void THcScalerEvtHandler::DefVars() -{ +void THcScalerEvtHandler::DefVars() { // called after AddVars has finished being called. Nvars = scalerloc.size(); - if (Nvars == 0) return; - dvars_prev_read = new UInt_t[Nvars]; // dvars_prev_read is a member of this class - dvars = new Double_t[Nvars]; // dvars is a member of this class - dvarsFirst = new Double_t[Nvars]; // dvarsFirst is a member of this class - memset(dvars, 0, Nvars*sizeof(Double_t)); - memset(dvars_prev_read, 0, Nvars*sizeof(UInt_t)); - memset(dvarsFirst, 0, Nvars*sizeof(Double_t)); + if (Nvars == 0) + return; + dvars_prev_read = new UInt_t[Nvars]; // dvars_prev_read is a member of this class + dvars = new Double_t[Nvars]; // dvars is a member of this class + dvarsFirst = new Double_t[Nvars]; // dvarsFirst is a member of this class + memset(dvars, 0, Nvars * sizeof(Double_t)); + memset(dvars_prev_read, 0, Nvars * sizeof(UInt_t)); + memset(dvarsFirst, 0, Nvars * sizeof(Double_t)); if (gHaVars) { - if(fDebugFile) *fDebugFile << "THcScalerEVtHandler:: Have gHaVars "<<gHaVars<<endl; + if (fDebugFile) + *fDebugFile << "THcScalerEVtHandler:: Have gHaVars " << gHaVars << endl; } else { - cout << "No gHaVars ?! Well, that's a problem !!"<<endl; + cout << "No gHaVars ?! Well, that's a problem !!" << endl; return; } - if(fDebugFile) *fDebugFile << "THcScalerEvtHandler:: scalerloc size "<<scalerloc.size()<<endl; + if (fDebugFile) + *fDebugFile << "THcScalerEvtHandler:: scalerloc size " << scalerloc.size() << endl; const Int_t* count = 0; for (size_t i = 0; i < scalerloc.size(); i++) { - gHaVars->DefineByType(scalerloc[i]->name.Data(), scalerloc[i]->description.Data(), - &dvars[i], kDouble, count); - //gHaVars->DefineByType(scalerloc[i]->name.Data(), scalerloc[i]->description.Data(), + gHaVars->DefineByType(scalerloc[i]->name.Data(), scalerloc[i]->description.Data(), &dvars[i], + kDouble, count); + // gHaVars->DefineByType(scalerloc[i]->name.Data(), scalerloc[i]->description.Data(), // &dvarsFirst[i], kDouble, count); } } -size_t THcScalerEvtHandler::FindNoCase(const string& sdata, const string& skey) -{ +size_t THcScalerEvtHandler::FindNoCase(const string& sdata, const string& skey) { // Find iterator of word "sdata" where "skey" starts. Case insensitive. string sdatalc, skeylc; - sdatalc = ""; skeylc = ""; - for (string::const_iterator p = - sdata.begin(); p != sdata.end(); ++p) { + sdatalc = ""; + skeylc = ""; + for (string::const_iterator p = sdata.begin(); p != sdata.end(); ++p) { sdatalc += tolower(*p); } - for (string::const_iterator p = - skey.begin(); p != skey.end(); ++p) { + for (string::const_iterator p = skey.begin(); p != skey.end(); ++p) { skeylc += tolower(*p); } - if (sdatalc.find(skeylc,0) == string::npos) return -1; - return sdatalc.find(skeylc,0); + if (sdatalc.find(skeylc, 0) == string::npos) + return -1; + return sdatalc.find(skeylc, 0); }; ClassImp(THcScalerEvtHandler) diff --git a/src/THcScalerEvtHandler.h b/src/THcScalerEvtHandler.h index 1e99e4a42e62e78eac2b96cde2b85dd8e430c108..f6e8b1c2a77c29fd5f5dad72cd55871df1e35d97 100644 --- a/src/THcScalerEvtHandler.h +++ b/src/THcScalerEvtHandler.h @@ -19,6 +19,7 @@ #include "TString.h" #include <cstring> +#include "hcana/Logger.h" class HCScalerLoc { // Utility class used by THcScalerEvtHandler public: @@ -31,7 +32,7 @@ class HCScalerLoc { // Utility class used by THcScalerEvtHandler UInt_t index, islot, ichan, ikind, ivar; }; -class THcScalerEvtHandler : public THaEvtTypeHandler { +class THcScalerEvtHandler : public hcana::ConfigLogging<THaEvtTypeHandler> { public: @@ -48,7 +49,6 @@ public: virtual void SetOnlyBanks(Bool_t b = kFALSE) {fOnlyBanks = b;fRocSet.clear();} virtual void SetOnlyUseSyncEvents(Bool_t b=kFALSE) {fOnlySyncEvents = b;} -private: void AddVars(TString name, TString desc, UInt_t iscal, UInt_t ichan, UInt_t ikind); void DefVars(); @@ -92,6 +92,8 @@ private: std::set<UInt_t> fRocSet; std::set<UInt_t> fModuleSet; +private: + THcScalerEvtHandler(const THcScalerEvtHandler& fh); THcScalerEvtHandler& operator=(const THcScalerEvtHandler& fh); diff --git a/src/THcScintillatorPlane.cxx b/src/THcScintillatorPlane.cxx index f2605e43df4e154a190c7878e619ecbfd9e98e7c..e584f856735d60ba85813ea551f9c162b8eccb47 100644 --- a/src/THcScintillatorPlane.cxx +++ b/src/THcScintillatorPlane.cxx @@ -282,7 +282,7 @@ Int_t THcScintillatorPlane::ReadDatabase( const TDatime& date ) fADCDiagCut = 50.0; fCosmicFlag=0; gHcParms->LoadParmValues((DBRequest*)&list,prefix); - if (fCosmicFlag==1) cout << " setup for cosmics in scint plane"<< endl; + if (fCosmicFlag==1) _det_logger->info("THcScintillatorPlane: setup for cosmics in scint plane"); // cout << " cosmic flag = " << fCosmicFlag << endl; // fetch the parameter from the temporary list @@ -478,6 +478,7 @@ Int_t THcScintillatorPlane::DefineVariables( EMode mode ) } //end debug statement RVarDef vars[] = { + {"betterTest", "List of positive TDC counter numbers.", "frPosTdcTimeRawBetter"}, //Hodo+ raw TDC occupancy {"nhits", "Number of paddle hits (passed TDC && ADC Min and Max cuts for either end)", "GetNScinHits() "}, {"posTdcCounter", "List of positive TDC counter numbers.", "frPosTdcTimeRaw.THcSignalHit.GetPaddleNumber()"}, //Hodo+ raw TDC occupancy diff --git a/src/THcScintillatorPlane.h b/src/THcScintillatorPlane.h index 72e17194f935b7a59e56b6edb24588f1f9a616c1..265ec190996fbdeb37d8bbd9699a79f38ca90560 100644 --- a/src/THcScintillatorPlane.h +++ b/src/THcScintillatorPlane.h @@ -95,6 +95,8 @@ class THcScintillatorPlane : public THaSubDetector { TClonesArray* frNegADCPeds; TClonesArray* fHodoHits; + std::vector<double> frPosTdcTimeRawBetter; + TClonesArray* frPosTdcTimeRaw; TClonesArray* frPosAdcPedRaw; TClonesArray* frPosAdcPulseIntRaw; diff --git a/src/THcSecondaryKine.cxx b/src/THcSecondaryKine.cxx index fe6ec834172592befcd5825701a1fb8fe19d6189..55c26f30422d1ccc28aee5fe2a76b57e04066bf7 100644 --- a/src/THcSecondaryKine.cxx +++ b/src/THcSecondaryKine.cxx @@ -124,21 +124,20 @@ THaAnalysisObject::EStatus THcSecondaryKine::Init( const TDatime& run_time ) fStatus = kOK; - fSpectro = dynamic_cast<THcHallCSpectrometer*> - ( FindModule( fSpectroName.Data(), "THcHallCSpectrometer")); + fSpectro = + dynamic_cast<THcHallCSpectrometer*>(FindModule(fSpectroName.Data(), "THcHallCSpectrometer")); if( !fSpectro ) { fStatus = kInitError; return fStatus; } - fPrimary = dynamic_cast<THcPrimaryKine*> - ( FindModule( fPrimaryName.Data(), "THcPrimaryKine")); - if(!fPrimary) { + fPrimary = dynamic_cast<THcPrimaryKine*>(FindModule(fPrimaryName.Data(), "THcPrimaryKine")); + if (!fPrimary) { fStatus = kInitError; return fStatus; } - if( (fStatus=THaPhysicsModule::Init( run_time )) != kOK ) { + if ((fStatus = THaPhysicsModule::Init(run_time)) != kOK) { return fStatus; } @@ -294,6 +293,7 @@ Int_t THcSecondaryKine::ReadDatabase( const TDatime& date ) prefix[0] = tolower(GetName()[0]); prefix[1] = '\0'; + _param_logger->info("THcSecondaryKine prefix = {}", prefix ); fOopCentralOffset = 0.0; DBRequest list[]={ {"_oopcentral_offset",&fOopCentralOffset,kDouble, 0, 1}, @@ -301,18 +301,19 @@ Int_t THcSecondaryKine::ReadDatabase( const TDatime& date ) {0} }; gHcParms->LoadParmValues((DBRequest*)&list,prefix); - cout << "THcSecondaryKine particleMASS: " << fMX << endl; - + //cout << "THcSecondaryKine particleMASS: " << fMX << endl; + _param_logger->info("THcSecondaryKine particleMASS: {}", fMX ); return kOK; } //_____________________________________________________________________________ void THcSecondaryKine::SetMX( Double_t m ) { - if( !IsInit()) - fMX = m; - else + if (!IsInit()) { + fMX = m; + } else { PrintInitError("SetMX()"); + } } //_____________________________________________________________________________ diff --git a/src/THcShower.cxx b/src/THcShower.cxx index fccca69fe4cf3a19cf790963ed78ecf017e5369a..81b387bc4d990ac1b6b88b5b995c0323c5faac73 100644 --- a/src/THcShower.cxx +++ b/src/THcShower.cxx @@ -33,7 +33,7 @@ using namespace std; //_____________________________________________________________________________ THcShower::THcShower( const char* name, const char* description, THaApparatus* apparatus ) : - THaNonTrackingDetector(name,description,apparatus), + hcana::ConfigLogging<THaNonTrackingDetector>(name,description,apparatus), fPosAdcTimeWindowMin(0), fNegAdcTimeWindowMin(0), fPosAdcTimeWindowMax(0), fNegAdcTimeWindowMax(0), fPedPosDefault(0),fPedNegDefault(0), @@ -51,7 +51,7 @@ THcShower::THcShower( const char* name, const char* description, //_____________________________________________________________________________ THcShower::THcShower( ) : - THaNonTrackingDetector(), + hcana::ConfigLogging<THaNonTrackingDetector>(), fPosAdcTimeWindowMin(0), fNegAdcTimeWindowMin(0), fPosAdcTimeWindowMax(0), fNegAdcTimeWindowMax(0), fPedPosDefault(0),fPedNegDefault(0), @@ -125,13 +125,13 @@ void THcShower::Setup(const char* name, const char* description) // cout << "---------------------------------------------------------------\n"; - cout << "From THcShower::Setup: created Shower planes for " - << GetApparatus()->GetName() << ": "; - - for(UInt_t i=0;i < fNTotLayers;i++) { - cout << fLayerNames[i]; - i < fNTotLayers-1 ? cout << ", " : cout << ".\n"; - } + _logger->info("From THcShower::Setup: created Shower planes for {} ", GetApparatus()->GetName()); + //cout << "From THcShower::Setup: created Shower planes for " + // << GetApparatus()->GetName() << ": "; + //for(UInt_t i=0;i < fNTotLayers;i++) { + // cout << fLayerNames[i]; + // i < fNTotLayers-1 ? cout << ", " : cout << ".\n"; + //} // if(fHasArray) // cout << fLayerNames[fNTotLayers-1] << " has fly\'s eye configuration\n"; diff --git a/src/THcShower.h b/src/THcShower.h index a0e425ddd6c7b74a2d35ad001caf68a8b6dc9b67..a5ab4395ca3e48861d5888c2d3178f6762461f6f 100644 --- a/src/THcShower.h +++ b/src/THcShower.h @@ -15,7 +15,9 @@ #include "THcShowerHit.h" #include "TMath.h" -class THcShower : public THaNonTrackingDetector, public THcHitList { +#include "hcana/Logger.h" + +class THcShower : public hcana::ConfigLogging<THaNonTrackingDetector>, public THcHitList { public: THcShower( const char* name, const char* description = "", diff --git a/src/THcShowerArray.h b/src/THcShowerArray.h index 229653f1adcfad1fb68255b7b8ed9aab5532b776..8f5dad6d2e679c0a0fb0a5da69a1de5906675fc2 100644 --- a/src/THcShowerArray.h +++ b/src/THcShowerArray.h @@ -81,7 +81,9 @@ public: Double_t GetEarray() { return fEarray; - }; + } + + Double_t* GetGains(){ return fGain; } // Fiducial volume limits. Double_t fvXmin(); diff --git a/src/THcShowerPlane.cxx b/src/THcShowerPlane.cxx index e839139001f1b39cf22d519166c78760f04b10bb..7cf0dc2fd8da783fbeb663e66d53608297bb591c 100644 --- a/src/THcShowerPlane.cxx +++ b/src/THcShowerPlane.cxx @@ -358,9 +358,9 @@ Int_t THcShowerPlane::DefineVariables( EMode mode ) gHcParms->Define(Form("%sstat_hitsum%d", fParent->GetPrefix(), fLayerNum), Form("Number of hits in calo. layer %d", fLayerNum), fTotStatNumHit); - cout << "THcShowerPlane::DefineVariables: registered counters " - << Form("%sstat_trksum%d",fParent->GetPrefix(),fLayerNum) << " and " - << Form("%sstat_hitsum%d",fParent->GetPrefix(),fLayerNum) << endl; + //cout << "THcShowerPlane::DefineVariables: registered counters " + // << Form("%sstat_trksum%d",fParent->GetPrefix(),fLayerNum) << " and " + // << Form("%sstat_hitsum%d",fParent->GetPrefix(),fLayerNum) << endl; // getchar(); RVarDef vars[] = { diff --git a/src/THcSpacePoint.h b/src/THcSpacePoint.h index 810156ffa5674b70972996dd0805db6c8b98558b..fb3f7ece63d937fa5090518091daef58fa9e5923 100644 --- a/src/THcSpacePoint.h +++ b/src/THcSpacePoint.h @@ -29,7 +29,7 @@ public: }; void SetXY(Double_t x, Double_t y) {fX = x; fY = y;}; - void Clear(Option_t* opt="") {fNHits=0; fNCombos=0; fHits.clear();}; + void Clear(Option_t* /* opt */ ="") {fNHits=0; fNCombos=0; fHits.clear();}; void AddHit(THcDCHit* hit) { Hit newhit; newhit.dchit = hit; diff --git a/src/THcTimeSyncEvtHandler.cxx b/src/THcTimeSyncEvtHandler.cxx index 01757aeecc6141b706953c7cf267030750328223..e29ea8572065c18ca14862eb4c5bf391128edc1e 100644 --- a/src/THcTimeSyncEvtHandler.cxx +++ b/src/THcTimeSyncEvtHandler.cxx @@ -209,7 +209,9 @@ Int_t THcTimeSyncEvtHandler::Analyze(THaEvData *evdata) fFirstTime = kFALSE; fDumpNew=2; } - if(issyncevent) cout << "SYNC event" << endl; + if(issyncevent){ + _param_logger->info("SYNC event"); + } AccumulateStats(fLastEventWasSync); fLastEventWasSync = issyncevent; @@ -220,7 +222,7 @@ Int_t THcTimeSyncEvtHandler::Analyze(THaEvData *evdata) fWriteDelayed=kTRUE; // cout << "Will write corrected event" << endl; } else { - cout << "Skipping event " << evdata->GetEvNum() << endl; + _param_logger->info( "Skipping event {}", evdata->GetEvNum() ); } } else { // Not slipping yet, just copy event if(fCodaOut) { @@ -500,7 +502,7 @@ void THcTimeSyncEvtHandler::AddExpectedOffset(Int_t roc, Int_t offset) { THaAnalysisObject::EStatus THcTimeSyncEvtHandler::Init(const TDatime& date) { - cout << "Howdy ! We are initializing THcTimeSyncEvtHandler !! name = "<<fName<<endl; + //cout << "Howdy ! We are initializing THcTimeSyncEvtHandler !! name = "<<fName<<endl; if(eventtypes.size()==0) { eventtypes.push_back(1); // If no event types specified, diff --git a/src/THcTrigDet.cxx b/src/THcTrigDet.cxx index 18bc16e9e7b8ed4c70d16543d44496c7f21e83b6..234a4a8ebabdb64db083c72cf014397e771262b1 100644 --- a/src/THcTrigDet.cxx +++ b/src/THcTrigDet.cxx @@ -377,12 +377,11 @@ Int_t THcTrigDet::ReadDatabase(const TDatime& date) { } } - cout << " Trig = " << fTrigNames.size() << endl; - for (UInt_t j = 0; j <fTrigNames.size(); j++) { - cout << fTrigNames[j] << " " << fTrigId[j] << endl; - } + _det_logger->info("Number of Triggers : {} ", fTrigNames.size()); + for (UInt_t j = 0; j <fTrigNames.size(); j++) { + _det_logger->info("{} {} ", fTrigNames[j],fTrigId[j]); + } - return kOK; } diff --git a/src/TrackingEfficiency.cxx b/src/TrackingEfficiency.cxx new file mode 100644 index 0000000000000000000000000000000000000000..53b055a53a4d19b9c5326e8f34ec3aff765292b0 --- /dev/null +++ b/src/TrackingEfficiency.cxx @@ -0,0 +1,451 @@ +#include "THaEvData.h" +#include "THaCutList.h" +#include "VarDef.h" +#include "VarType.h" +#include "TClonesArray.h" + +#include <cstdio> +#include <cstdlib> +#include <cstring> +#include <iostream> + +#include "THaApparatus.h" +#include "THcGlobals.h" +#include "THcHodoHit.h" +#include "THcParmList.h" +#include "TrackingEfficiency.h" + +namespace hcana { + + using namespace std; + + TrackingEfficiency::TrackingEfficiency(const char* name, const char* description, + const char* hodname) + : THaPhysicsModule(name, description) {} + + TrackingEfficiency::~TrackingEfficiency() { + // Destructor + RemoveVariables(); + } + //_____________________________________________________________________________ + + void TrackingEfficiency::Reset(Option_t* opt) + // Clear event-by-event data + { + Clear(opt); + } + + //_____________________________________________________________________________ + Int_t TrackingEfficiency::Begin(THaRunBase*) { + // Start of analysis + + //if (!IsOK()) + // return -1; + + //// Book any special histograms here + + //fNevt = 0; + + //// Clear all the accumulators here + //for (Int_t ip = 0; ip < fNPlanes; ip++) { + // fHitPlane[ip] = 0; + // for (Int_t ic = 0; ic < fNCounters[ip]; ic++) { + // fStatPosHit[ip][ic] = 0; + // fStatNegHit[ip][ic] = 0; + // fStatAndHit[ip][ic] = 0; + // fStatOrHit[ip][ic] = 0; + // fBothGood[ip][ic] = 0; + // fPosGood[ip][ic] = 0; + // fNegGood[ip][ic] = 0; + // for (Int_t idel = 0; idel < 20; idel++) { + // fStatTrkDel[ip][ic][idel] = 0; + // fStatAndHitDel[ip][ic][idel] = 0; + // } + // } + //} + + return 0; + } + + //_____________________________________________________________________________ + Int_t TrackingEfficiency::End(THaRunBase*) { + //// End of analysis + //for (Int_t ip = 0; ip < fNPlanes; ip++) { + // fStatAndEff[ip] = 0; + // for (Int_t ic = 0; ic < fNCounters[ip]; ic++) { + // fStatTrkSum[ip] += fStatTrk[fHod->GetScinIndex(ip, ic)]; + // fStatAndSum[ip] += fHodoAndEffi[fHod->GetScinIndex(ip, ic)]; + // } + // if (fStatTrkSum[ip] != 0) + // fStatAndEff[ip] = float(fStatAndSum[ip]) / float(fStatTrkSum[ip]); + //} + //// + //Double_t p1 = fStatAndEff[0]; + //Double_t p2 = fStatAndEff[1]; + //Double_t p3 = fStatAndEff[2]; + //Double_t p4 = fStatAndEff[3]; + //// probability that ONLY the listed planes had triggers + //Double_t p1234 = p1 * p2 * p3 * p4; + //Double_t p123 = p1 * p2 * p3 * (1. - p4); + //Double_t p124 = p1 * p2 * (1. - p3) * p4; + //Double_t p134 = p1 * (1. - p2) * p3 * p4; + //Double_t p234 = (1. - p1) * p2 * p3 * p4; + //fHodoEff_s1 = 1. - ((1. - p1) * (1. - p2)); + //fHodoEff_s2 = 1. - ((1. - p3) * (1. - p4)); + //fHodoEff_tof = fHodoEff_s1 * fHodoEff_s2; + //fHodoEff_3_of_4 = p1234 + p123 + p124 + p134 + p234; + //fHodoEff_4_of_4 = p1234; + return 0; + } + + //_____________________________________________________________________________ + THaAnalysisObject::EStatus TrackingEfficiency::Init(const TDatime& run_time) { + // Initialize TrackingEfficiency physics module + + // const char* const here = "Init"; + + // Standard initialization. Calls ReadDatabase(), ReadRunDatabase(), + // and DefineVariables() (see THaAnalysisObject::Init) + + //fHod = dynamic_cast<THcHodoscope*>(FindModule(fName.Data(), "THcHodoscope")); + + //fSpectro = static_cast<THaSpectrometer*>(fHod->GetApparatus()); + + //if (THaPhysicsModule::Init(run_time) != kOK) + // return fStatus; + + //cout << "TrackingEfficiency::Init nplanes=" << fHod->GetNPlanes() << endl; + //cout << "TrackingEfficiency::Init Apparatus = " << fHod->GetName() << " " + // << (fHod->GetApparatus())->GetName() << endl; + + return fStatus = kOK; + } + + //_____________________________________________________________________________ + Int_t TrackingEfficiency::ReadDatabase(const TDatime& date) { + //// Read database. Gets variable needed for efficiency calculation + //// Get # of planes and their z positions here. + + //fNPlanes = fHod->GetNPlanes(); + //fPlanes = new THcScintillatorPlane*[fNPlanes]; + //fPosZ = new Double_t[fNPlanes]; + //fSpacing = new Double_t[fNPlanes]; + //fCenterFirst = new Double_t[fNPlanes]; + //fNCounters = new Int_t[fNPlanes]; + //fHodoSlop = new Double_t[fNPlanes]; + //fStatTrkSum = new Int_t[fNPlanes]; + //fStatAndSum = new Int_t[fNPlanes]; + //fStatAndEff = new Double_t[fNPlanes]; + + //Int_t maxcountersperplane = 0; + //for (Int_t ip = 0; ip < fNPlanes; ip++) { + // fStatTrkSum[ip] = 0.; + // fStatAndSum[ip] = 0.; + // fStatAndEff[ip] = 0.; + // fPlanes[ip] = fHod->GetPlane(ip); + // fPosZ[ip] = fPlanes[ip]->GetZpos() + 0.5 * fPlanes[ip]->GetDzpos(); + // fSpacing[ip] = fPlanes[ip]->GetSpacing(); + // fCenterFirst[ip] = fPlanes[ip]->GetPosCenter(0) + fPlanes[ip]->GetPosOffset(); + // fNCounters[ip] = fPlanes[ip]->GetNelem(); + // maxcountersperplane = TMath::Max(maxcountersperplane, fNCounters[ip]); + //} + //Int_t totalpaddles = fNPlanes * maxcountersperplane; + //fHodoPosEffi = new Int_t[totalpaddles]; + //fHodoNegEffi = new Int_t[totalpaddles]; + //fHodoOrEffi = new Int_t[totalpaddles]; + //fHodoAndEffi = new Int_t[totalpaddles]; + //fStatTrk = new Int_t[totalpaddles]; + + //char prefix[2]; + //prefix[0] = tolower((fHod->GetApparatus())->GetName()[0]); + //prefix[1] = '\0'; + + //DBRequest list[] = {{"stat_slop", &fStatSlop, kDouble}, + // {"stat_maxchisq", &fMaxChisq, kDouble}, + // {"HodoEff_CalEnergy_Cut", &fHodoEff_CalEnergy_Cut, kDouble, 0, 1}, + // {"hodo_slop", fHodoSlop, kDouble, (UInt_t)fNPlanes}, + // {0}}; + //fHodoEff_CalEnergy_Cut = 0.050; // set default value + //gHcParms->LoadParmValues((DBRequest*)&list, prefix); + //cout << "\n\nTrackingEfficiency::ReadDatabase nplanes=" << fHod->GetNPlanes() << endl; + //// Setup statistics arrays + //// Better method to put this in? + //// These all need to be cleared in Begin + //fHitPlane = new Int_t[fNPlanes]; + //fStatTrkDel.resize(fNPlanes); + //fStatAndHitDel.resize(fNPlanes); + //fStatPosHit.resize(fNPlanes); + //fStatNegHit.resize(fNPlanes); + //fStatAndHit.resize(fNPlanes); + //fStatOrHit.resize(fNPlanes); + //fBothGood.resize(fNPlanes); + //fPosGood.resize(fNPlanes); + //fNegGood.resize(fNPlanes); + + //for (Int_t ip = 0; ip < fNPlanes; ip++) { + + // cout << "Plane = " << ip + 1 << " counters = " << fNCounters[ip] << endl; + + // fStatTrkDel[ip].resize(fNCounters[ip]); + // fStatAndHitDel[ip].resize(fNCounters[ip]); + // fStatPosHit[ip].resize(fNCounters[ip]); + // fStatNegHit[ip].resize(fNCounters[ip]); + // fStatAndHit[ip].resize(fNCounters[ip]); + // fStatOrHit[ip].resize(fNCounters[ip]); + // fBothGood[ip].resize(fNCounters[ip]); + // fPosGood[ip].resize(fNCounters[ip]); + // fNegGood[ip].resize(fNCounters[ip]); + // for (Int_t ic = 0; ic < fNCounters[ip]; ic++) { + // fStatTrkDel[ip][ic].resize(20); // Max this settable + // fStatAndHitDel[ip][ic].resize(20); // Max this settable + + // fHodoPosEffi[fHod->GetScinIndex(ip, ic)] = 0; + // fHodoNegEffi[fHod->GetScinIndex(ip, ic)] = 0; + // fHodoOrEffi[fHod->GetScinIndex(ip, ic)] = 0; + // fHodoAndEffi[fHod->GetScinIndex(ip, ic)] = 0; + // fStatTrk[fHod->GetScinIndex(ip, ic)] = 0; + // } + //} + + //// Int_t fHodPaddles = fNCounters[0]; + //// gHcParms->Define(Form("%shodo_pos_hits[%d][%d]",fPrefix,fNPlanes,fHodPaddles), + //// "Golden track's pos pmt hit",*&fStatPosHit); + + //gHcParms->Define(Form("%shodo_pos_eff[%d]", prefix, totalpaddles), "Hodo positive effi", + // *fHodoPosEffi); + //gHcParms->Define(Form("%shodo_neg_eff[%d]", prefix, totalpaddles), "Hodo negative effi", + // *fHodoNegEffi); + //gHcParms->Define(Form("%shodo_or_eff[%d]", prefix, totalpaddles), "Hodo or effi", *fHodoOrEffi); + //gHcParms->Define(Form("%shodo_and_eff[%d]", prefix, totalpaddles), "Hodo and effi", + // *fHodoAndEffi); + //gHcParms->Define(Form("%shodo_plane_AND_eff[%d]", prefix, fNPlanes), "Hodo plane AND eff", + // *fStatAndEff); + //gHcParms->Define(Form("%shodo_gold_hits[%d]", prefix, totalpaddles), "Hodo golden hits", + // *fStatTrk); + //gHcParms->Define(Form("%shodo_s1XY_eff", prefix), "Efficiency for S1XY", fHodoEff_s1); + //gHcParms->Define(Form("%shodo_s2XY_eff", prefix), "Efficiency for S2XY", fHodoEff_s2); + //gHcParms->Define(Form("%shodo_stof_eff", prefix), "Efficiency for STOF", fHodoEff_tof); + //gHcParms->Define(Form("%shodo_3_of_4_eff", prefix), "Efficiency for 3 of 4", fHodoEff_3_of_4); + //gHcParms->Define(Form("%shodo_4_of_4_eff", prefix), "Efficiency for 4 of 4", fHodoEff_4_of_4); + + return kOK; + } + + //_____________________________________________________________________________ + Int_t TrackingEfficiency::DefineVariables(EMode mode) { + + //if (mode == kDefine && fIsSetup) + // return kOK; + //fIsSetup = (mode == kDefine); + + //// fEffiTest = 0; + //// gHcParms->Define(Form("hodoeffi"),"Testing effi",fEffiTest); + + //const RVarDef vars[] = {// Move these into THcHallCSpectrometer using track fTracks + // // {"effitestvar", "efficiency test var", "fEffiTest"}, + // // {"goldhodposhit", "pos pmt hit in hodo", "fStatPosHit"}, + // {0}}; + //return DefineVarsFromList(vars, mode); + return kOK; + } + + //_____________________________________________________________________________ + Int_t TrackingEfficiency::Process(const THaEvData& evdata) { + // Accumulate statistics for efficiency + + // const char* const here = "Process"; + + if (!IsOK()) + return -1; + + //// Project the golden track to each + //// plane. Need to get track at Focal Plane, not tgt. + //// + //// Assumes that planes are X, Y, X, Y + //THaTrack* theTrack = fSpectro->GetGoldenTrack(); + //// Since fSpectro knows the index of the golden track, we can + //// get other information about the track from fSpectro. + //// Need to remove the specialized stuff from fGoldenTrack + + //if (!theTrack) + // return 0; + //Int_t trackIndex = theTrack->GetTrkNum() - 1; + + //// May make these member variables + //Double_t hitPos[fNPlanes]; + //Double_t hitDistance[fNPlanes]; + //Int_t hitCounter[fNPlanes]; + //Int_t checkHit[fNPlanes]; + //// Bool_t goodTdcBothSides[fNPlanes]; + //// Bool_t goodTdcOneSide[fNPlanes]; + + //for (Int_t ip = 0; ip < fNPlanes; ip++) { + // // Should really have plane object self identify as X or Y + // if (ip % 2 == 0) { // X Plane + // hitPos[ip] = theTrack->GetX() + theTrack->GetTheta() * fPosZ[ip]; + // hitCounter[ip] = + // TMath::Max(TMath::Min(TMath::Nint((hitPos[ip] - fCenterFirst[ip]) / fSpacing[ip] + 1), + // fNCounters[ip]), + // 1); + // hitDistance[ip] = hitPos[ip] - (fSpacing[ip] * (hitCounter[ip] - 1) + fCenterFirst[ip]); + // } else { // Y Plane + // hitPos[ip] = theTrack->GetY() + theTrack->GetPhi() * fPosZ[ip]; + // hitCounter[ip] = + // TMath::Max(TMath::Min(TMath::Nint((fCenterFirst[ip] - hitPos[ip]) / fSpacing[ip] + 1), + // fNCounters[ip]), + // 1); + // hitDistance[ip] = hitPos[ip] - (fCenterFirst[ip] - fSpacing[ip] * (hitCounter[ip] - 1)); + // } + //} + + //// Fill dpos histograms and set checkHit for each plane. + //// dpos stuff not implemented + //// Why do dpos stuff here, does any other part need the dpos historgrams + //// Look to VDCEff code to see how to create and fill histograms + + //for (Int_t ip = 0; ip < fNPlanes; ip++) { + // Int_t hitcounter = hitCounter[ip]; + // // goodTdcBothSides[ip] = kFALSE; + // // goodTdcOneSide[ip] = kFALSE; + // checkHit[ip] = 2; + // Int_t nphits = fPlanes[ip]->GetNScinHits(); + // TClonesArray* hodoHits = fPlanes[ip]->GetHits(); + // for (Int_t ihit = 0; ihit < nphits; ihit++) { + // THcHodoHit* hit = (THcHodoHit*)hodoHits->At(ihit); + // Int_t counter = hit->GetPaddleNumber(); + // if (counter == hitcounter) { + // checkHit[ip] = 0; + // } else { + // if (TMath::Abs(counter - hitcounter) == 1 && checkHit[ip] != 0) { + // checkHit[ip] = 1; + // } + // } + // } + //} + + //// Record position differences between track and center of scin + //// and increment 'should have hit' counters + //for (Int_t ip = 0; ip < fNPlanes; ip++) { + // // Int_t hitcounter = hitCounter[ip]; + // Double_t dist = hitDistance[ip]; + // if (TMath::Abs(dist) <= fStatSlop && theTrack->GetChi2() / theTrack->GetNDoF() <= fMaxChisq && + // theTrack->GetEnergy() >= fHodoEff_CalEnergy_Cut) { + // fStatTrk[fHod->GetScinIndex(ip, hitCounter[ip] - 1)]++; + // // Double_t delta = theTrack->GetDp(); + // // Int_t idel = TMath::Floor(delta+10.0); + // // Should + // // if(idel >=0 && idel < 20) { + // // fStatTrkDel[ip][hitcounter][idel]++; + // // } + // // lookat[ip] = TRUE; + // } + // fHitPlane[ip] = 0; + //} + //// Is there a hit on or adjacent to paddle that track + //// passes through? + + //// May collapse this loop into last + + //// record the hits as a "didhit" if track is near center of + //// scintillator, the chisqared of the track is good and it is the + //// first "didhit" in that plane. + + //for (Int_t ip = 0; ip < fNPlanes; ip++) { + // Int_t hitcounter = hitCounter[ip]; + // if (hitcounter >= fNCounters[ip]) + // hitcounter = fNCounters[ip] - 1; + // if (hitcounter < 0) + // hitcounter = 0; + // Double_t dist = hitDistance[ip]; + // Int_t nphits = fPlanes[ip]->GetNScinHits(); + // TClonesArray* hodoHits = fPlanes[ip]->GetHits(); + // for (Int_t ihit = 0; ihit < nphits; ihit++) { + // THcHodoHit* hit = (THcHodoHit*)hodoHits->At(ihit); + // Int_t counter = hit->GetPaddleNumber(); + // // Finds first best hit + // Bool_t onTrack, goodScinTime, goodTdcNeg, goodTdcPos; + // fHod->GetFlags(trackIndex, ip, ihit, onTrack, goodScinTime, goodTdcNeg, goodTdcPos); + // if (TMath::Abs(dist) <= fStatSlop && TMath::Abs(hitcounter - counter) <= checkHit[ip] && + // fHitPlane[ip] == 0 && theTrack->GetChi2() / theTrack->GetNDoF() <= fMaxChisq && + // theTrack->GetEnergy() >= fHodoEff_CalEnergy_Cut) { + // fHitPlane[ip]++; + + // // Need to find out hgood_tdc_pos(igoldentrack,ihit) and neg + // if (goodTdcPos) { + // if (goodTdcNeg) { // Both fired + // fStatPosHit[ip][hitcounter]++; + // fStatNegHit[ip][hitcounter]++; + // fStatAndHit[ip][hitcounter]++; + // fStatOrHit[ip][hitcounter]++; + + // fHodoPosEffi[fHod->GetScinIndex(ip, hitCounter[ip] - 1)]++; + // fHodoNegEffi[fHod->GetScinIndex(ip, hitCounter[ip] - 1)]++; + // fHodoAndEffi[fHod->GetScinIndex(ip, hitCounter[ip] - 1)]++; + // fHodoOrEffi[fHod->GetScinIndex(ip, hitCounter[ip] - 1)]++; + + // // Double_t delta = theTrack->GetDp(); + // // Int_t idel = TMath::Floor(delta+10.0); + // // if(idel >=0 && idel < 20) { + // // fStatAndHitDel[ip][hitcounter][idel]++; + // // } + // } else { + // fStatPosHit[ip][hitcounter]++; + // fStatOrHit[ip][hitcounter]++; + // fHodoPosEffi[fHod->GetScinIndex(ip, hitCounter[ip] - 1)]++; + // fHodoOrEffi[fHod->GetScinIndex(ip, hitCounter[ip] - 1)]++; + // } + // } else if (goodTdcNeg) { + // fStatNegHit[ip][hitcounter]++; + // fStatOrHit[ip][hitcounter]++; + // fHodoNegEffi[fHod->GetScinIndex(ip, hitCounter[ip] - 1)]++; + // fHodoOrEffi[fHod->GetScinIndex(ip, hitCounter[ip] - 1)]++; + // } + + // // Increment pos/neg/both fired. Track independent, so + // // no chisquared cut, but note that only scintillators on the + // // track are examined. + // if (goodTdcPos) { + // if (goodTdcNeg) { + // fBothGood[ip][hitcounter]++; + // } else { + // fPosGood[ip][hitcounter]++; + // } + // } else if (goodTdcNeg) { + // fNegGood[ip][hitcounter]++; + // } + // // Determine if one or both PMTs had a good tdc + + // // if(goodTdcPos && goodTdcNeg) { + // // goodTdcBothSides[ip] = kTRUE; + // // } + // // if(goodTdcPos || goodTdcNeg) { + // // goodTdcOneSide[ip] = kTRUE; + // // } + // } + + // /* + // For each plane, see of other 3 fired. This means that they were enough + // to form a 3/4 trigger, and so the fraction of times this plane fired is + // the plane trigger efficiency. NOTE: we only require a TDC hit, not a + // TDC hit within the SCIN 3/4 trigger window, so high rates will make + // this seem better than it is. Also, make sure we're not near the edge + // of the hodoscope (at the last plane), using the same hhodo_slop param. + // as for h_tof.f + // NOTE ALSO: to make this check simpler, we are assuming that all planes + // have identical active areas. y_scin = y_cent + y_offset, so shift track + // position by offset for comparing to edges. + // */ + + // // Need to add calculation and cuts on + // // xatback and yatback in order to set the + // // htrig_hododidflag, htrig_hodoshouldflag and otherthreehit flags + // // + + // ++fNevt; + // } + //} + return 0; + } + +} // namespace hcana + diff --git a/src/TrackingEfficiency.h b/src/TrackingEfficiency.h new file mode 100644 index 0000000000000000000000000000000000000000..5e2ea1b5866891e87ab41c6c8a119eaf9af941f3 --- /dev/null +++ b/src/TrackingEfficiency.h @@ -0,0 +1,104 @@ +#ifndef ROOT_TrackingEfficiency +#define ROOT_TrackingEfficiency + +/////////////////////////////////////////////////////////////////////////////// +// // +// TrackingEfficiency // +// // +/////////////////////////////////////////////////////////////////////////////// + +#include "THaEvData.h" +#include "THaCutList.h" +#include "VarDef.h" +#include "VarType.h" +#include "TClonesArray.h" + +#include <cstring> +#include <cstdio> +#include <cstdlib> +#include <iostream> + +#include "THaPhysicsModule.h" +#include "THcHodoscope.h" +#include "THaSpectrometer.h" +#include "THaTrack.h" + +namespace hcana { + + + /** \brief TrackingEfficiency calculation. + * + * \ingroup PhysMods + */ + class TrackingEfficiency : public THaPhysicsModule { + public: + TrackingEfficiency(const char* name, const char* description, const char* hodname); + virtual ~TrackingEfficiency(); + + virtual Int_t Begin(THaRunBase* r = 0); + virtual Int_t End(THaRunBase* r = 0); + virtual EStatus Init(const TDatime& run_time); + virtual Int_t Process(const THaEvData&); + + void Reset(Option_t* opt = ""); + + protected: + virtual Int_t ReadDatabase(const TDatime& date); + virtual Int_t DefineVariables(EMode mode = kDefine); + /* Int_t GetScinIndex(Int_t nPlane, Int_t nPaddle); */ + + // Data needed for efficiency calculation for one Hodoscope paddle + + // Double_t* fZPos; // + + // TString fName; // Name of hodoscope + // THcHodoscope* fHod; // Hodscope object + // THaSpectrometer* fSpectro; // Spectrometer object + + // Long64_t fNevt; + + //// Information about the hodoscopes that we get from the + //// THcHodoscope object + + // Int_t fEffiTest; + // Int_t fNPlanes; + // THcScintillatorPlane** fPlanes; + // Double_t* fPosZ; + // Double_t* fSpacing; + // Double_t* fCenterFirst; + // Int_t* fNCounters; + //// Int_t* fHodoPlnContHit; + // Int_t* fHodoPosEffi; + // Int_t* fHodoNegEffi; + // Int_t* fHodoOrEffi; + // Int_t* fHodoAndEffi; + // Int_t* fStatTrk; + // Int_t* fStatTrkSum; + // Int_t* fStatAndSum; + // Double_t* fStatAndEff; + // Double_t fStatSlop; + // Double_t fHodoEff_CalEnergy_Cut; + // Double_t fMaxChisq; + // Double_t* fHodoSlop; + // Double_t fHodoEff_s1, fHodoEff_s2, fHodoEff_tof, fHodoEff_3_of_4, fHodoEff_4_of_4; + + //// Arrays for accumulating statistics + // vector<vector<vector<Int_t>>> fHitShould; + // vector<vector<vector<Int_t>>> fStatAndHitDel; + // vector<vector<vector<Int_t>>> fStatTrkDel; + // vector<vector<Int_t>> fStatPosHit; + // vector<vector<Int_t>> fStatNegHit; + // vector<vector<Int_t>> fStatAndHit; + // vector<vector<Int_t>> fStatOrHit; + // vector<vector<Int_t>> fBothGood; + // vector<vector<Int_t>> fNegGood; + // vector<vector<Int_t>> fPosGood; + + // Int_t* fHitPlane; + + ClassDef(TrackingEfficiency, 0) // Hodoscope efficiency module + }; + +} // namespace hcana + +#endif diff --git a/src/include/HallC_LinkDef.h b/src/include/HallC_LinkDef.h new file mode 100644 index 0000000000000000000000000000000000000000..16bbbdcc07138c8c554abe3132701f26c014a3d1 --- /dev/null +++ b/src/include/HallC_LinkDef.h @@ -0,0 +1,96 @@ +// Preamble to HallC_LinkDef.h file + +#ifdef __CINT__ + +#pragma link off all globals; +#pragma link off all classes; +#pragma link off all functions; + +#pragma link C++ nestedclass; +#pragma link C++ nestedtypedef; + +#pragma link C++ namespace hallc; +#pragma link C++ namespace hcana; +#pragma link C++ namespace podd2; + +#pragma link C++ namespace hallc::data; + +#pragma link C++ class hallc::data::Hodoscope+; +#pragma link C++ class hallc::data::DriftChamber+; + +#pragma link C++ class hallc::data::PulseWaveForm+; +#pragma link C++ class std::vector < hallc::data::PulseWaveForm>+; + +#pragma link C++ class podd2::HitLogging < TObject>+; + +#pragma link C++ global gHcParms; +#pragma link C++ global gHcDetectorMap; + +#pragma link C++ class Decoder::Scaler9001+; +#pragma link C++ class Decoder::Scaler9250+; +#pragma link C++ class THcAerogel+; +#pragma link C++ class THcAerogelHit+; +#pragma link C++ class THcAnalyzer+; +#pragma link C++ class THcBCMCurrent+; +#pragma link C++ class THcCherenkov+; +#pragma link C++ class THcCherenkovHit+; +#pragma link C++ class THcCoinTime+; +#pragma link C++ class THcConfigEvtHandler+; +#pragma link C++ class THcDC+; +#pragma link C++ class THcDCHit+; +#pragma link C++ class THcDCLookupTTDConv+; +#pragma link C++ class THcDCTimeToDistConv+; +#pragma link C++ class THcDCTrack+; +#pragma link C++ class THcDCWire+; +#pragma link C++ class THcDetectorMap+; +#pragma link C++ class THcDriftChamber+; +#pragma link C++ class THcDriftChamberPlane+; +#pragma link C++ class THcDummySpectrometer+; +#pragma link C++ class THcExtTarCor+; +#pragma link C++ class THcFormula+; +#pragma link C++ class THcHallCSpectrometer+; +#pragma link C++ class THcHitList+; +#pragma link C++ class THcHodoEff+; +#pragma link C++ class THcHelicity+; +#pragma link C++ class THcHelicityReader+; +#pragma link C++ class THcHelicityScaler+; +#pragma link C++ class THcHodoHit+; +#pragma link C++ class THcHodoscope+; +#pragma link C++ class THcInterface+; +#pragma link C++ class THcParmList+; +#pragma link C++ class THcPeriodicReport+; +#pragma link C++ class THcPrimaryKine+; +#pragma link C++ class THcRaster+; +#pragma link C++ class THcRasteredBeam+; +#pragma link C++ class THcRasterRawHit+; +#pragma link C++ class THcRawAdcHit+; +#pragma link C++ class THcRawDCHit+; +#pragma link C++ class THcRawHit+; +#pragma link C++ class THcRawHodoHit+; +#pragma link C++ class THcRawShowerHit+; +#pragma link C++ class THcRawTdcHit+; +#pragma link C++ class THcReactionPoint+; +#pragma link C++ class THcRun+; +#pragma link C++ class THcRunParameters+; +#pragma link C++ class THcScalerEvtHandler+; +#pragma link C++ class THcScintillatorPlane+; +#pragma link C++ class THcScintPlaneCluster+; +#pragma link C++ class THcSecondaryKine+; +#pragma link C++ class THcShowerArray+; +#pragma link C++ class THcShower+; +#pragma link C++ class THcShowerHit+; +#pragma link C++ class THcShowerPlane+; +#pragma link C++ class THcSignalHit+; +#pragma link C++ class THcSpacePoint+; +#pragma link C++ class THcTimeSyncEvtHandler+; +#pragma link C++ class THcTrigApp+; +#pragma link C++ class THcTrigDet+; +#pragma link C++ class THcTrigRawHit+; +#pragma link C++ class Decoder::TIBlobModule+; + +#pragma link C++ class hcana::Shower2+; +#pragma link C++ class hcana::Scandalizer+; +#pragma link C++ class hcana::TrackingEfficiency+; + +// Postamble for HallC_Linkdef.h file +#endif diff --git a/src/include/hcana/HallC_Data.h b/src/include/hcana/HallC_Data.h new file mode 100644 index 0000000000000000000000000000000000000000..dc6afe4d2dbb0f013492b13da9c784174f309d79 --- /dev/null +++ b/src/include/hcana/HallC_Data.h @@ -0,0 +1,30 @@ +#ifndef hallc_HallC_Data_HH +#define hallc_HallC_Data_HH + +#include <array> +#include <algorithm> + +namespace hallc { + namespace data { + + + /** Stores the digitized pulse data in a fixed size array. + */ + struct PulseWaveForm { + static const UInt_t MaxNPulses = 4; + static const UInt_t MaxNSamples = 511; + // From THcRawAdcHit.h + PulseWaveForm() {} + PulseWaveForm(Int_t* buf, Int_t size = MaxNSamples) { std::copy_n(buf, size, std::begin(_buffer)); } + virtual ~PulseWaveForm() {} + + void ZeroBuffer() { std::fill(std::begin(_buffer), std::end(_buffer), 0); } + + std::array<Int_t, MaxNSamples> _buffer; + + ClassDef(PulseWaveForm, 1) + }; + } +} + +#endif diff --git a/src/include/hcana/Logger.h b/src/include/hcana/Logger.h new file mode 100644 index 0000000000000000000000000000000000000000..86165fc8cab604ef91842437e291029eb2022061 --- /dev/null +++ b/src/include/hcana/Logger.h @@ -0,0 +1,30 @@ +#ifndef hallc_hcana_Logger_hh +#define hallc_hcana_Logger_hh + +#include "podd2/Logger.h" + +//#include "podd2/spdlog/spdlog.h" +//#include "podd2/spdlog/sinks/stdout_color_sinks.h" //support for stdout logging +//#include "podd2/spdlog/sinks/basic_file_sink.h" // support for basic file logging + +namespace hcana { + + template <typename Base> + using RunLogging = podd2::RunLogging<Base>; + + template <typename Base> + using ConfigLogging = podd2::ConfigLogging<Base>; + + template <typename Base> + using HitLogging = podd2::HitLogging<Base>; + + template <typename Base> + using DetectorLogging = podd2::DetectorLogging<Base>; + + template <typename Base> + using SpectrometerLogging = podd2::SpectrometerLogging<Base>; + +} + + +#endif diff --git a/src/include/hcana/helpers.hxx b/src/include/hcana/helpers.hxx new file mode 100644 index 0000000000000000000000000000000000000000..d48b3f425c1df86045aef026091fd4e28dd58074 --- /dev/null +++ b/src/include/hcana/helpers.hxx @@ -0,0 +1,335 @@ +#ifndef hcana_algos_hh +#define hcana_algos_hh + +#include <algorithm> +#include <array> +#include <iostream> +#include <iterator> +#include <tuple> +#include <type_traits> +#include <utility> + +namespace hcana { + + template <typename Vector, typename Value> + auto lower_bound(Vector&& v, const Value& val) + { + return std::lower_bound(std::begin(v), std::end(v), val); + } + + template <typename Vector, typename Value> + auto upper_bound(Vector&& v, const Value& val) + { + return std::upper_bound(std::begin(v), std::end(v), val); + } + + template <typename Vector, typename Value> + auto bounds(Vector&& v, const Value& val) + { + return std::make_pair(std::lower_bound(std::begin(v), std::end(v), val), + std::upper_bound(std::begin(v), std::end(v), val)); + } + + template <typename Vector, typename Value, typename Fun> + auto lower_bound(Vector&& v, const Value& val, Fun fun) + { + return std::lower_bound(std::begin(v), std::end(v), val, fun); + } + + template <typename Vector, typename Value, typename Fun> + auto upper_bound(Vector&& v, const Value& val, Fun fun) + { + return std::upper_bound(std::begin(v), std::end(v), val, fun); + } + + template <typename Vector, typename Value, typename Fun> + auto bounds(Vector&& v, const Value& val, Fun fun) + { + return std::make_pair(std::lower_bound(std::begin(v), std::end(v), val, fun), + std::upper_bound(std::begin(v), std::end(v), val, fun)); + } + + template <typename Vector> + auto adjacent_find(Vector&& v) { + return std::adjacent_find(std::begin(v), std::end(v)); + } + + template <typename Vector, typename Fun> + auto adjacent_find(Vector&& v, Fun fun) { + return std::adjacent_find(std::begin(v), std::end(v), fun); + } + + /** Returns the iterator to first discontinuous element. + * If container is continuous it resturns std::end(v). + * This version uses the increment operator on the container type to test for "continuity". + */ + template <class ForwardIt> + auto find_discontinuity_impl(ForwardIt first, ForwardIt last) { + if (first == last ){ + // empty container + return last; + } + auto result = first; + for (auto it = first; it != last; it++) { + if (it + 1 == last) { + // Got to the end without finding discontinutity + return last; + } + auto val = *it; + if (*(it + 1) != ++val) { + return it+1; + } + } + return last; + } + + /** Returns the iterator to first discontinuous element. + * If container is continuous it resturns std::end(v). + */ + template <typename Vector> + auto find_discontinuity(Vector&& v) { + return find_discontinuity_impl(std::begin(v), std::end(v)); + } + + /** Returns the iterator to first discontinuous element. + * If container is continuous it resturns std::end(v). + * \param Fun is a binary predcate of the the form [](T x1, T x2)->bool{} + * which returns true if x1 and x2 are "continuous". + */ + template <typename ForwardIt, typename Fun> + auto find_discontinuity_impl(ForwardIt first, ForwardIt last, Fun fun) { + if (first == last ){ + // empty container + return last; + } + auto result = first; + for(auto it = first; it != last; it++) { + if (it + 1 == last) { + // Got to the end without finding discontinutity + return last; + } + auto val = *it; + if (!fun(val,*(it + 1))) { + return it+1; + } + } + return last; + } + template <typename Vector, typename Fun> + auto find_discontinuity(Vector&& v, Fun fun) { + return find_discontinuity_impl(std::begin(v), std::end(v), fun); + } + + /** Returns the number of discountinuties of a container. + * A range of zero size, single element, or continuous range will return 0. + */ + template <typename Vector> + auto count_discontinuities(Vector&& v) { + auto first = std::begin(v); + auto last = std::end(v); + auto current = find_discontinuity_impl(first, last); + int count = 0; + while (current != last) { + current = find_discontinuity_impl(current, last); + count++; + } + return count; + } + + template <typename Vector, typename Fun> + auto count_discontinuities(Vector&& v, Fun fun) { + auto first = std::begin(v); + auto last = std::end(v); + auto current = find_discontinuity_impl(first, last, fun); + int count = 0; + while (current != last) { + current = find_discontinuity_impl(current, last, fun); + count++; + } + return count; + } + + /** Returns a vector of iterators to the start of each discontiuitiy. + * + */ + template <typename Vector> + auto get_discontinuities(Vector&& v) { + auto first = std::begin(v); + auto last = std::end(v); + using Iterator = decltype(first); + std::vector<std::pair<Iterator, Iterator>> cont_ranges; + auto current = find_discontinuity_impl(first, last); + cont_ranges.push_back(std::make_pair(first, current)); + while (current != last) { + auto prev = current; + current = find_discontinuity_impl(current, last); + cont_ranges.push_back(std::make_pair(prev, current)); + } + return cont_ranges; + } + /** Returns a vector of iterators to the start of each discontiuitiy. + * + */ + template <typename Vector, typename Fun> + auto get_discontinuities(Vector&& v, Fun fun) { + auto first = std::begin(v); + auto last = std::end(v); + using Iterator = decltype(first); + std::vector<std::pair<Iterator, Iterator>> cont_ranges; + auto current = find_discontinuity_impl(first, last, fun); + //std::vector<Vector::iterator> res = {first}; + cont_ranges.push_back(std::make_pair(first, current)); + while (current != last) { + auto prev = current; + current = find_discontinuity_impl(current, last, fun); + cont_ranges.push_back(std::make_pair(prev, current)); + } + return cont_ranges; + } + //{ + // std::vector<int> test_vector = {1,2,5,6,7, 9,10, 20}; + // auto test_res = hcana::find_discontinuity(test_vector); + // std::cout << " find_discontinuity test: " << *test_res << "\n"; + //} + //{ + // std::vector<int> test_vector = {0,2,4,8,10,12,13, 16,18,20,23}; + // auto test_res = hcana::find_discontinuity( + // test_vector, [](const int& x1, const int& x2) { return x1 + 2 == x2; }); + // std::cout << " find_discontinuity test2: " << *test_res << "\n"; + //} + + template <typename Vector, typename Value> + auto find(Vector&& v, const Value& val) + { + return std::find(std::begin(v), std::end(v), val); + } + + template <typename Vector, typename Fun> + auto find_if(Vector&& v, Fun fun) + { + return std::find_if(std::begin(v), std::end(v), fun); + } + + template <typename Vector, typename Value> + auto* ptr_find(Vector&& v, const Value& val) + { + auto it = std::find(std::begin(v), std::end(v), val); + return it != std::end(v) ? &*it : nullptr; + } + + template <typename Vector, typename Fun> + auto* ptr_find_if(Vector&& v, Fun fun) + { + auto it = std::find_if(std::begin(v), std::end(v), fun); + return it != std::end(v) ? &*it : nullptr; + } + + template <typename Vector, typename Value> + bool contains(Vector&& v, const Value& val) + { + return find(v, val) != std::end(v); + } + + template <typename Vector, typename Value> + void remove_one(Vector&& v, const Value& val) + { + auto it = find(v, val); + if (it != v.end()) + { + v.erase(it); + } + } + + template <typename Vector, typename Function> + void remove_one_if(Vector&& v, const Function& val) + { + auto it = find_if(v, val); + if (it != v.end()) + { + v.erase(it); + } + } + + template <typename Vector, typename Fun> + bool any_of(Vector&& v, Fun fun) + { + return std::any_of(std::begin(v), std::end(v), fun); + } + + template <typename Vector, typename Fun> + auto all_of(Vector&& v, Fun fun) + { + return std::all_of(std::begin(v), std::end(v), fun); + } + + template <typename Vector, typename Fun> + bool none_of(Vector&& v, Fun fun) + { + return std::none_of(std::begin(v), std::end(v), fun); + } + + template <typename Vector, typename Fun> + auto remove_if(Vector&& v, Fun fun) + { + return std::remove_if(std::begin(v), std::end(v), fun); + } + + template <typename Vector, typename Fun> + auto count_if(Vector&& v, Fun fun) + { + return std::count_if(std::begin(v), std::end(v), fun); + } + + template <typename Vector, typename Fun> + auto max_element(Vector&& v, Fun fun) + { + return std::max_element(std::begin(v), std::end(v), fun); + } + + template <typename Vector> + auto sort(Vector&& v) + { + return std::sort(std::begin(v), std::end(v)); + } + + template <typename Vector, typename T> + auto fill(Vector&& v, const T& val) + { + return std::fill(std::begin(v), std::end(v), val); + } + + template <typename Vector> + auto unique(Vector&& v) + { + return std::unique(std::begin(v), std::end(v)); + } + + template <typename Vector, typename Fun> + auto sort(Vector&& v, Fun fun) + { + return std::sort(std::begin(v), std::end(v), fun); + } + + template <typename Vector, typename OutputIterator, typename Fun> + auto transform(Vector&& v, OutputIterator it, Fun f) + { + return std::transform(v.begin(), v.end(), it, f); + } + + template <typename Vector1, typename Vector2> + void copy(const Vector1& source, Vector2& destination) + { + destination.reserve(destination.size() + source.size()); + std::copy(source.begin(), source.end(), std::back_inserter(destination)); + } + + template <typename Vector1, typename Vector2, typename Pred> + void copy_if(const Vector1& source, Vector2& destination, Pred predicate) + { + std::copy_if( + source.begin(), source.end(), std::back_inserter(destination), + predicate); + } +} + +#endif diff --git a/src/nlohmann/json.hpp b/src/nlohmann/json.hpp new file mode 100644 index 0000000000000000000000000000000000000000..51f16def38c494a051e5f40da9e13fc82f43415f --- /dev/null +++ b/src/nlohmann/json.hpp @@ -0,0 +1,18590 @@ +/* + __ _____ _____ _____ + __| | __| | | | JSON for Modern C++ +| | |__ | | | | | | version 3.1.2 +|_____|_____|_____|_|___| https://github.com/nlohmann/json + +Licensed under the MIT License <http://opensource.org/licenses/MIT>. +SPDX-License-Identifier: MIT +Copyright (c) 2013-2018 Niels Lohmann <http://nlohmann.me>. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +#ifndef NLOHMANN_JSON_HPP +#define NLOHMANN_JSON_HPP + +#define NLOHMANN_JSON_VERSION_MAJOR 3 +#define NLOHMANN_JSON_VERSION_MINOR 1 +#define NLOHMANN_JSON_VERSION_PATCH 2 + +#include <algorithm> // all_of, find, for_each +#include <cassert> // assert +#include <ciso646> // and, not, or +#include <cstddef> // nullptr_t, ptrdiff_t, size_t +#include <functional> // hash, less +#include <initializer_list> // initializer_list +#include <iosfwd> // istream, ostream +#include <iterator> // iterator_traits, random_access_iterator_tag +#include <numeric> // accumulate +#include <string> // string, stoi, to_string +#include <utility> // declval, forward, move, pair, swap + +// #include <nlohmann/json_fwd.hpp> +#ifndef NLOHMANN_JSON_FWD_HPP +#define NLOHMANN_JSON_FWD_HPP + +#include <cstdint> // int64_t, uint64_t +#include <map> // map +#include <memory> // allocator +#include <string> // string +#include <vector> // vector + +/*! +@brief namespace for Niels Lohmann +@see https://github.com/nlohmann +@since version 1.0.0 +*/ +namespace nlohmann +{ +/*! +@brief default JSONSerializer template argument + +This serializer ignores the template arguments and uses ADL +([argument-dependent lookup](https://en.cppreference.com/w/cpp/language/adl)) +for serialization. +*/ +template<typename T = void, typename SFINAE = void> +struct adl_serializer; + +template<template<typename U, typename V, typename... Args> class ObjectType = + std::map, + template<typename U, typename... Args> class ArrayType = std::vector, + class StringType = std::string, class BooleanType = bool, + class NumberIntegerType = std::int64_t, + class NumberUnsignedType = std::uint64_t, + class NumberFloatType = double, + template<typename U> class AllocatorType = std::allocator, + template<typename T, typename SFINAE = void> class JSONSerializer = + adl_serializer> +class basic_json; + +/*! +@brief JSON Pointer + +A JSON pointer defines a string syntax for identifying a specific value +within a JSON document. It can be used with functions `at` and +`operator[]`. Furthermore, JSON pointers are the base for JSON patches. + +@sa [RFC 6901](https://tools.ietf.org/html/rfc6901) + +@since version 2.0.0 +*/ +template<typename BasicJsonType> +class json_pointer; + +/*! +@brief default JSON class + +This type is the default specialization of the @ref basic_json class which +uses the standard template types. + +@since version 1.0.0 +*/ +using json = basic_json<>; +} + +#endif + +// #include <nlohmann/detail/macro_scope.hpp> + + +// This file contains all internal macro definitions +// You MUST include macro_unscope.hpp at the end of json.hpp to undef all of them + +// exclude unsupported compilers +#if !defined(JSON_SKIP_UNSUPPORTED_COMPILER_CHECK) + #if defined(__clang__) + #if (__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__) < 30400 + #error "unsupported Clang version - see https://github.com/nlohmann/json#supported-compilers" + #endif + #elif defined(__GNUC__) && !(defined(__ICC) || defined(__INTEL_COMPILER)) + #if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) < 40900 + #error "unsupported GCC version - see https://github.com/nlohmann/json#supported-compilers" + #endif + #endif +#endif + +// disable float-equal warnings on GCC/clang +#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wfloat-equal" +#endif + +// disable documentation warnings on clang +#if defined(__clang__) + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wdocumentation" +#endif + +// allow for portable deprecation warnings +#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) + #define JSON_DEPRECATED __attribute__((deprecated)) +#elif defined(_MSC_VER) + #define JSON_DEPRECATED __declspec(deprecated) +#else + #define JSON_DEPRECATED +#endif + +// allow to disable exceptions +#if (defined(__cpp_exceptions) || defined(__EXCEPTIONS) || defined(_CPPUNWIND)) && !defined(JSON_NOEXCEPTION) + #define JSON_THROW(exception) throw exception + #define JSON_TRY try + #define JSON_CATCH(exception) catch(exception) +#else + #define JSON_THROW(exception) std::abort() + #define JSON_TRY if(true) + #define JSON_CATCH(exception) if(false) +#endif + +// override exception macros +#if defined(JSON_THROW_USER) + #undef JSON_THROW + #define JSON_THROW JSON_THROW_USER +#endif +#if defined(JSON_TRY_USER) + #undef JSON_TRY + #define JSON_TRY JSON_TRY_USER +#endif +#if defined(JSON_CATCH_USER) + #undef JSON_CATCH + #define JSON_CATCH JSON_CATCH_USER +#endif + +// manual branch prediction +#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) + #define JSON_LIKELY(x) __builtin_expect(!!(x), 1) + #define JSON_UNLIKELY(x) __builtin_expect(!!(x), 0) +#else + #define JSON_LIKELY(x) x + #define JSON_UNLIKELY(x) x +#endif + +// C++ language standard detection +#if (defined(__cplusplus) && __cplusplus >= 201703L) || (defined(_HAS_CXX17) && _HAS_CXX17 == 1) // fix for issue #464 + #define JSON_HAS_CPP_17 + #define JSON_HAS_CPP_14 +#elif (defined(__cplusplus) && __cplusplus >= 201402L) || (defined(_HAS_CXX14) && _HAS_CXX14 == 1) + #define JSON_HAS_CPP_14 +#endif + +// Ugly macros to avoid uglier copy-paste when specializing basic_json. They +// may be removed in the future once the class is split. + +#define NLOHMANN_BASIC_JSON_TPL_DECLARATION \ + template<template<typename, typename, typename...> class ObjectType, \ + template<typename, typename...> class ArrayType, \ + class StringType, class BooleanType, class NumberIntegerType, \ + class NumberUnsignedType, class NumberFloatType, \ + template<typename> class AllocatorType, \ + template<typename, typename = void> class JSONSerializer> + +#define NLOHMANN_BASIC_JSON_TPL \ + basic_json<ObjectType, ArrayType, StringType, BooleanType, \ + NumberIntegerType, NumberUnsignedType, NumberFloatType, \ + AllocatorType, JSONSerializer> + +/*! +@brief Helper to determine whether there's a key_type for T. + +This helper is used to tell associative containers apart from other containers +such as sequence containers. For instance, `std::map` passes the test as it +contains a `mapped_type`, whereas `std::vector` fails the test. + +@sa http://stackoverflow.com/a/7728728/266378 +@since version 1.0.0, overworked in version 2.0.6 +*/ +#define NLOHMANN_JSON_HAS_HELPER(type) \ + template<typename T> struct has_##type { \ + private: \ + template<typename U, typename = typename U::type> \ + static int detect(U &&); \ + static void detect(...); \ + public: \ + static constexpr bool value = \ + std::is_integral<decltype(detect(std::declval<T>()))>::value; \ + } + +// #include <nlohmann/detail/meta.hpp> + + +#include <ciso646> // not +#include <cstddef> // size_t +#include <limits> // numeric_limits +#include <type_traits> // conditional, enable_if, false_type, integral_constant, is_constructible, is_integral, is_same, remove_cv, remove_reference, true_type +#include <utility> // declval + +// #include <nlohmann/json_fwd.hpp> + +// #include <nlohmann/detail/macro_scope.hpp> + + +namespace nlohmann +{ +/*! +@brief detail namespace with internal helper functions + +This namespace collects functions that should not be exposed, +implementations of some @ref basic_json methods, and meta-programming helpers. + +@since version 2.1.0 +*/ +namespace detail +{ +///////////// +// helpers // +///////////// + +template<typename> struct is_basic_json : std::false_type {}; + +NLOHMANN_BASIC_JSON_TPL_DECLARATION +struct is_basic_json<NLOHMANN_BASIC_JSON_TPL> : std::true_type {}; + +// alias templates to reduce boilerplate +template<bool B, typename T = void> +using enable_if_t = typename std::enable_if<B, T>::type; + +template<typename T> +using uncvref_t = typename std::remove_cv<typename std::remove_reference<T>::type>::type; + +// implementation of C++14 index_sequence and affiliates +// source: https://stackoverflow.com/a/32223343 +template<std::size_t... Ints> +struct index_sequence +{ + using type = index_sequence; + using value_type = std::size_t; + static constexpr std::size_t size() noexcept + { + return sizeof...(Ints); + } +}; + +template<class Sequence1, class Sequence2> +struct merge_and_renumber; + +template<std::size_t... I1, std::size_t... I2> +struct merge_and_renumber<index_sequence<I1...>, index_sequence<I2...>> + : index_sequence < I1..., (sizeof...(I1) + I2)... > {}; + +template<std::size_t N> +struct make_index_sequence + : merge_and_renumber < typename make_index_sequence < N / 2 >::type, + typename make_index_sequence < N - N / 2 >::type > {}; + +template<> struct make_index_sequence<0> : index_sequence<> {}; +template<> struct make_index_sequence<1> : index_sequence<0> {}; + +template<typename... Ts> +using index_sequence_for = make_index_sequence<sizeof...(Ts)>; + +/* +Implementation of two C++17 constructs: conjunction, negation. This is needed +to avoid evaluating all the traits in a condition + +For example: not std::is_same<void, T>::value and has_value_type<T>::value +will not compile when T = void (on MSVC at least). Whereas +conjunction<negation<std::is_same<void, T>>, has_value_type<T>>::value will +stop evaluating if negation<...>::value == false + +Please note that those constructs must be used with caution, since symbols can +become very long quickly (which can slow down compilation and cause MSVC +internal compiler errors). Only use it when you have to (see example ahead). +*/ +template<class...> struct conjunction : std::true_type {}; +template<class B1> struct conjunction<B1> : B1 {}; +template<class B1, class... Bn> +struct conjunction<B1, Bn...> : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {}; + +template<class B> struct negation : std::integral_constant<bool, not B::value> {}; + +// dispatch utility (taken from ranges-v3) +template<unsigned N> struct priority_tag : priority_tag < N - 1 > {}; +template<> struct priority_tag<0> {}; + +//////////////////////// +// has_/is_ functions // +//////////////////////// + +// source: https://stackoverflow.com/a/37193089/4116453 + +template <typename T, typename = void> +struct is_complete_type : std::false_type {}; + +template <typename T> +struct is_complete_type<T, decltype(void(sizeof(T)))> : std::true_type {}; + +NLOHMANN_JSON_HAS_HELPER(mapped_type); +NLOHMANN_JSON_HAS_HELPER(key_type); +NLOHMANN_JSON_HAS_HELPER(value_type); +NLOHMANN_JSON_HAS_HELPER(iterator); + +template<bool B, class RealType, class CompatibleObjectType> +struct is_compatible_object_type_impl : std::false_type {}; + +template<class RealType, class CompatibleObjectType> +struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType> +{ + static constexpr auto value = + std::is_constructible<typename RealType::key_type, typename CompatibleObjectType::key_type>::value and + std::is_constructible<typename RealType::mapped_type, typename CompatibleObjectType::mapped_type>::value; +}; + +template<bool B, class RealType, class CompatibleStringType> +struct is_compatible_string_type_impl : std::false_type {}; + +template<class RealType, class CompatibleStringType> +struct is_compatible_string_type_impl<true, RealType, CompatibleStringType> +{ + static constexpr auto value = + std::is_same<typename RealType::value_type, typename CompatibleStringType::value_type>::value and + std::is_constructible<RealType, CompatibleStringType>::value; +}; + +template<class BasicJsonType, class CompatibleObjectType> +struct is_compatible_object_type +{ + static auto constexpr value = is_compatible_object_type_impl < + conjunction<negation<std::is_same<void, CompatibleObjectType>>, + has_mapped_type<CompatibleObjectType>, + has_key_type<CompatibleObjectType>>::value, + typename BasicJsonType::object_t, CompatibleObjectType >::value; +}; + +template<class BasicJsonType, class CompatibleStringType> +struct is_compatible_string_type +{ + static auto constexpr value = is_compatible_string_type_impl < + conjunction<negation<std::is_same<void, CompatibleStringType>>, + has_value_type<CompatibleStringType>>::value, + typename BasicJsonType::string_t, CompatibleStringType >::value; +}; + +template<typename BasicJsonType, typename T> +struct is_basic_json_nested_type +{ + static auto constexpr value = std::is_same<T, typename BasicJsonType::iterator>::value or + std::is_same<T, typename BasicJsonType::const_iterator>::value or + std::is_same<T, typename BasicJsonType::reverse_iterator>::value or + std::is_same<T, typename BasicJsonType::const_reverse_iterator>::value; +}; + +template<class BasicJsonType, class CompatibleArrayType> +struct is_compatible_array_type +{ + static auto constexpr value = + conjunction<negation<std::is_same<void, CompatibleArrayType>>, + negation<is_compatible_object_type< + BasicJsonType, CompatibleArrayType>>, + negation<std::is_constructible<typename BasicJsonType::string_t, + CompatibleArrayType>>, + negation<is_basic_json_nested_type<BasicJsonType, CompatibleArrayType>>, + has_value_type<CompatibleArrayType>, + has_iterator<CompatibleArrayType>>::value; +}; + +template<bool, typename, typename> +struct is_compatible_integer_type_impl : std::false_type {}; + +template<typename RealIntegerType, typename CompatibleNumberIntegerType> +struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType> +{ + // is there an assert somewhere on overflows? + using RealLimits = std::numeric_limits<RealIntegerType>; + using CompatibleLimits = std::numeric_limits<CompatibleNumberIntegerType>; + + static constexpr auto value = + std::is_constructible<RealIntegerType, CompatibleNumberIntegerType>::value and + CompatibleLimits::is_integer and + RealLimits::is_signed == CompatibleLimits::is_signed; +}; + +template<typename RealIntegerType, typename CompatibleNumberIntegerType> +struct is_compatible_integer_type +{ + static constexpr auto value = + is_compatible_integer_type_impl < + std::is_integral<CompatibleNumberIntegerType>::value and + not std::is_same<bool, CompatibleNumberIntegerType>::value, + RealIntegerType, CompatibleNumberIntegerType > ::value; +}; + +// trait checking if JSONSerializer<T>::from_json(json const&, udt&) exists +template<typename BasicJsonType, typename T> +struct has_from_json +{ + private: + // also check the return type of from_json + template<typename U, typename = enable_if_t<std::is_same<void, decltype(uncvref_t<U>::from_json( + std::declval<BasicJsonType>(), std::declval<T&>()))>::value>> + static int detect(U&&); + static void detect(...); + + public: + static constexpr bool value = std::is_integral<decltype( + detect(std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value; +}; + +// This trait checks if JSONSerializer<T>::from_json(json const&) exists +// this overload is used for non-default-constructible user-defined-types +template<typename BasicJsonType, typename T> +struct has_non_default_from_json +{ + private: + template < + typename U, + typename = enable_if_t<std::is_same< + T, decltype(uncvref_t<U>::from_json(std::declval<BasicJsonType>()))>::value >> + static int detect(U&&); + static void detect(...); + + public: + static constexpr bool value = std::is_integral<decltype(detect( + std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value; +}; + +// This trait checks if BasicJsonType::json_serializer<T>::to_json exists +template<typename BasicJsonType, typename T> +struct has_to_json +{ + private: + template<typename U, typename = decltype(uncvref_t<U>::to_json( + std::declval<BasicJsonType&>(), std::declval<T>()))> + static int detect(U&&); + static void detect(...); + + public: + static constexpr bool value = std::is_integral<decltype(detect( + std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value; +}; + +template <typename BasicJsonType, typename CompatibleCompleteType> +struct is_compatible_complete_type +{ + static constexpr bool value = + not std::is_base_of<std::istream, CompatibleCompleteType>::value and + not is_basic_json<CompatibleCompleteType>::value and + not is_basic_json_nested_type<BasicJsonType, CompatibleCompleteType>::value and + has_to_json<BasicJsonType, CompatibleCompleteType>::value; +}; + +template <typename BasicJsonType, typename CompatibleType> +struct is_compatible_type + : conjunction<is_complete_type<CompatibleType>, + is_compatible_complete_type<BasicJsonType, CompatibleType>> +{ +}; + +// taken from ranges-v3 +template<typename T> +struct static_const +{ + static constexpr T value{}; +}; + +template<typename T> +constexpr T static_const<T>::value; +} +} + +// #include <nlohmann/detail/exceptions.hpp> + + +#include <exception> // exception +#include <stdexcept> // runtime_error +#include <string> // to_string + +namespace nlohmann +{ +namespace detail +{ +//////////////// +// exceptions // +//////////////// + +/*! +@brief general exception of the @ref basic_json class + +This class is an extension of `std::exception` objects with a member @a id for +exception ids. It is used as the base class for all exceptions thrown by the +@ref basic_json class. This class can hence be used as "wildcard" to catch +exceptions. + +Subclasses: +- @ref parse_error for exceptions indicating a parse error +- @ref invalid_iterator for exceptions indicating errors with iterators +- @ref type_error for exceptions indicating executing a member function with + a wrong type +- @ref out_of_range for exceptions indicating access out of the defined range +- @ref other_error for exceptions indicating other library errors + +@internal +@note To have nothrow-copy-constructible exceptions, we internally use + `std::runtime_error` which can cope with arbitrary-length error messages. + Intermediate strings are built with static functions and then passed to + the actual constructor. +@endinternal + +@liveexample{The following code shows how arbitrary library exceptions can be +caught.,exception} + +@since version 3.0.0 +*/ +class exception : public std::exception +{ + public: + /// returns the explanatory string + const char* what() const noexcept override + { + return m.what(); + } + + /// the id of the exception + const int id; + + protected: + exception(int id_, const char* what_arg) : id(id_), m(what_arg) {} + + static std::string name(const std::string& ename, int id_) + { + return "[json.exception." + ename + "." + std::to_string(id_) + "] "; + } + + private: + /// an exception object as storage for error messages + std::runtime_error m; +}; + +/*! +@brief exception indicating a parse error + +This exception is thrown by the library when a parse error occurs. Parse errors +can occur during the deserialization of JSON text, CBOR, MessagePack, as well +as when using JSON Patch. + +Member @a byte holds the byte index of the last read character in the input +file. + +Exceptions have ids 1xx. + +name / id | example message | description +------------------------------ | --------------- | ------------------------- +json.exception.parse_error.101 | parse error at 2: unexpected end of input; expected string literal | This error indicates a syntax error while deserializing a JSON text. The error message describes that an unexpected token (character) was encountered, and the member @a byte indicates the error position. +json.exception.parse_error.102 | parse error at 14: missing or wrong low surrogate | JSON uses the `\uxxxx` format to describe Unicode characters. Code points above above 0xFFFF are split into two `\uxxxx` entries ("surrogate pairs"). This error indicates that the surrogate pair is incomplete or contains an invalid code point. +json.exception.parse_error.103 | parse error: code points above 0x10FFFF are invalid | Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are invalid. +json.exception.parse_error.104 | parse error: JSON patch must be an array of objects | [RFC 6902](https://tools.ietf.org/html/rfc6902) requires a JSON Patch document to be a JSON document that represents an array of objects. +json.exception.parse_error.105 | parse error: operation must have string member 'op' | An operation of a JSON Patch document must contain exactly one "op" member, whose value indicates the operation to perform. Its value must be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors. +json.exception.parse_error.106 | parse error: array index '01' must not begin with '0' | An array index in a JSON Pointer ([RFC 6901](https://tools.ietf.org/html/rfc6901)) may be `0` or any number without a leading `0`. +json.exception.parse_error.107 | parse error: JSON pointer must be empty or begin with '/' - was: 'foo' | A JSON Pointer must be a Unicode string containing a sequence of zero or more reference tokens, each prefixed by a `/` character. +json.exception.parse_error.108 | parse error: escape character '~' must be followed with '0' or '1' | In a JSON Pointer, only `~0` and `~1` are valid escape sequences. +json.exception.parse_error.109 | parse error: array index 'one' is not a number | A JSON Pointer array index must be a number. +json.exception.parse_error.110 | parse error at 1: cannot read 2 bytes from vector | When parsing CBOR or MessagePack, the byte vector ends before the complete value has been read. +json.exception.parse_error.112 | parse error at 1: error reading CBOR; last byte: 0xF8 | Not all types of CBOR or MessagePack are supported. This exception occurs if an unsupported byte was read. +json.exception.parse_error.113 | parse error at 2: expected a CBOR string; last byte: 0x98 | While parsing a map key, a value that is not a string has been read. + +@note For an input with n bytes, 1 is the index of the first character and n+1 + is the index of the terminating null byte or the end of file. This also + holds true when reading a byte vector (CBOR or MessagePack). + +@liveexample{The following code shows how a `parse_error` exception can be +caught.,parse_error} + +@sa @ref exception for the base class of the library exceptions +@sa @ref invalid_iterator for exceptions indicating errors with iterators +@sa @ref type_error for exceptions indicating executing a member function with + a wrong type +@sa @ref out_of_range for exceptions indicating access out of the defined range +@sa @ref other_error for exceptions indicating other library errors + +@since version 3.0.0 +*/ +class parse_error : public exception +{ + public: + /*! + @brief create a parse error exception + @param[in] id_ the id of the exception + @param[in] byte_ the byte index where the error occurred (or 0 if the + position cannot be determined) + @param[in] what_arg the explanatory string + @return parse_error object + */ + static parse_error create(int id_, std::size_t byte_, const std::string& what_arg) + { + std::string w = exception::name("parse_error", id_) + "parse error" + + (byte_ != 0 ? (" at " + std::to_string(byte_)) : "") + + ": " + what_arg; + return parse_error(id_, byte_, w.c_str()); + } + + /*! + @brief byte index of the parse error + + The byte index of the last read character in the input file. + + @note For an input with n bytes, 1 is the index of the first character and + n+1 is the index of the terminating null byte or the end of file. + This also holds true when reading a byte vector (CBOR or MessagePack). + */ + const std::size_t byte; + + private: + parse_error(int id_, std::size_t byte_, const char* what_arg) + : exception(id_, what_arg), byte(byte_) {} +}; + +/*! +@brief exception indicating errors with iterators + +This exception is thrown if iterators passed to a library function do not match +the expected semantics. + +Exceptions have ids 2xx. + +name / id | example message | description +----------------------------------- | --------------- | ------------------------- +json.exception.invalid_iterator.201 | iterators are not compatible | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid. +json.exception.invalid_iterator.202 | iterator does not fit current value | In an erase or insert function, the passed iterator @a pos does not belong to the JSON value for which the function was called. It hence does not define a valid position for the deletion/insertion. +json.exception.invalid_iterator.203 | iterators do not fit current value | Either iterator passed to function @ref erase(IteratorType first, IteratorType last) does not belong to the JSON value from which values shall be erased. It hence does not define a valid range to delete values from. +json.exception.invalid_iterator.204 | iterators out of range | When an iterator range for a primitive type (number, boolean, or string) is passed to a constructor or an erase function, this range has to be exactly (@ref begin(), @ref end()), because this is the only way the single stored value is expressed. All other ranges are invalid. +json.exception.invalid_iterator.205 | iterator out of range | When an iterator for a primitive type (number, boolean, or string) is passed to an erase function, the iterator has to be the @ref begin() iterator, because it is the only way to address the stored value. All other iterators are invalid. +json.exception.invalid_iterator.206 | cannot construct with iterators from null | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) belong to a JSON null value and hence to not define a valid range. +json.exception.invalid_iterator.207 | cannot use key() for non-object iterators | The key() member function can only be used on iterators belonging to a JSON object, because other types do not have a concept of a key. +json.exception.invalid_iterator.208 | cannot use operator[] for object iterators | The operator[] to specify a concrete offset cannot be used on iterators belonging to a JSON object, because JSON objects are unordered. +json.exception.invalid_iterator.209 | cannot use offsets with object iterators | The offset operators (+, -, +=, -=) cannot be used on iterators belonging to a JSON object, because JSON objects are unordered. +json.exception.invalid_iterator.210 | iterators do not fit | The iterator range passed to the insert function are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid. +json.exception.invalid_iterator.211 | passed iterators may not belong to container | The iterator range passed to the insert function must not be a subrange of the container to insert to. +json.exception.invalid_iterator.212 | cannot compare iterators of different containers | When two iterators are compared, they must belong to the same container. +json.exception.invalid_iterator.213 | cannot compare order of object iterators | The order of object iterators cannot be compared, because JSON objects are unordered. +json.exception.invalid_iterator.214 | cannot get value | Cannot get value for iterator: Either the iterator belongs to a null value or it is an iterator to a primitive type (number, boolean, or string), but the iterator is different to @ref begin(). + +@liveexample{The following code shows how an `invalid_iterator` exception can be +caught.,invalid_iterator} + +@sa @ref exception for the base class of the library exceptions +@sa @ref parse_error for exceptions indicating a parse error +@sa @ref type_error for exceptions indicating executing a member function with + a wrong type +@sa @ref out_of_range for exceptions indicating access out of the defined range +@sa @ref other_error for exceptions indicating other library errors + +@since version 3.0.0 +*/ +class invalid_iterator : public exception +{ + public: + static invalid_iterator create(int id_, const std::string& what_arg) + { + std::string w = exception::name("invalid_iterator", id_) + what_arg; + return invalid_iterator(id_, w.c_str()); + } + + private: + invalid_iterator(int id_, const char* what_arg) + : exception(id_, what_arg) {} +}; + +/*! +@brief exception indicating executing a member function with a wrong type + +This exception is thrown in case of a type error; that is, a library function is +executed on a JSON value whose type does not match the expected semantics. + +Exceptions have ids 3xx. + +name / id | example message | description +----------------------------- | --------------- | ------------------------- +json.exception.type_error.301 | cannot create object from initializer list | To create an object from an initializer list, the initializer list must consist only of a list of pairs whose first element is a string. When this constraint is violated, an array is created instead. +json.exception.type_error.302 | type must be object, but is array | During implicit or explicit value conversion, the JSON type must be compatible to the target type. For instance, a JSON string can only be converted into string types, but not into numbers or boolean types. +json.exception.type_error.303 | incompatible ReferenceType for get_ref, actual type is object | To retrieve a reference to a value stored in a @ref basic_json object with @ref get_ref, the type of the reference must match the value type. For instance, for a JSON array, the @a ReferenceType must be @ref array_t&. +json.exception.type_error.304 | cannot use at() with string | The @ref at() member functions can only be executed for certain JSON types. +json.exception.type_error.305 | cannot use operator[] with string | The @ref operator[] member functions can only be executed for certain JSON types. +json.exception.type_error.306 | cannot use value() with string | The @ref value() member functions can only be executed for certain JSON types. +json.exception.type_error.307 | cannot use erase() with string | The @ref erase() member functions can only be executed for certain JSON types. +json.exception.type_error.308 | cannot use push_back() with string | The @ref push_back() and @ref operator+= member functions can only be executed for certain JSON types. +json.exception.type_error.309 | cannot use insert() with | The @ref insert() member functions can only be executed for certain JSON types. +json.exception.type_error.310 | cannot use swap() with number | The @ref swap() member functions can only be executed for certain JSON types. +json.exception.type_error.311 | cannot use emplace_back() with string | The @ref emplace_back() member function can only be executed for certain JSON types. +json.exception.type_error.312 | cannot use update() with string | The @ref update() member functions can only be executed for certain JSON types. +json.exception.type_error.313 | invalid value to unflatten | The @ref unflatten function converts an object whose keys are JSON Pointers back into an arbitrary nested JSON value. The JSON Pointers must not overlap, because then the resulting value would not be well defined. +json.exception.type_error.314 | only objects can be unflattened | The @ref unflatten function only works for an object whose keys are JSON Pointers. +json.exception.type_error.315 | values in object must be primitive | The @ref unflatten function only works for an object whose keys are JSON Pointers and whose values are primitive. +json.exception.type_error.316 | invalid UTF-8 byte at index 10: 0x7E | The @ref dump function only works with UTF-8 encoded strings; that is, if you assign a `std::string` to a JSON value, make sure it is UTF-8 encoded. | + +@liveexample{The following code shows how a `type_error` exception can be +caught.,type_error} + +@sa @ref exception for the base class of the library exceptions +@sa @ref parse_error for exceptions indicating a parse error +@sa @ref invalid_iterator for exceptions indicating errors with iterators +@sa @ref out_of_range for exceptions indicating access out of the defined range +@sa @ref other_error for exceptions indicating other library errors + +@since version 3.0.0 +*/ +class type_error : public exception +{ + public: + static type_error create(int id_, const std::string& what_arg) + { + std::string w = exception::name("type_error", id_) + what_arg; + return type_error(id_, w.c_str()); + } + + private: + type_error(int id_, const char* what_arg) : exception(id_, what_arg) {} +}; + +/*! +@brief exception indicating access out of the defined range + +This exception is thrown in case a library function is called on an input +parameter that exceeds the expected range, for instance in case of array +indices or nonexisting object keys. + +Exceptions have ids 4xx. + +name / id | example message | description +------------------------------- | --------------- | ------------------------- +json.exception.out_of_range.401 | array index 3 is out of range | The provided array index @a i is larger than @a size-1. +json.exception.out_of_range.402 | array index '-' (3) is out of range | The special array index `-` in a JSON Pointer never describes a valid element of the array, but the index past the end. That is, it can only be used to add elements at this position, but not to read it. +json.exception.out_of_range.403 | key 'foo' not found | The provided key was not found in the JSON object. +json.exception.out_of_range.404 | unresolved reference token 'foo' | A reference token in a JSON Pointer could not be resolved. +json.exception.out_of_range.405 | JSON pointer has no parent | The JSON Patch operations 'remove' and 'add' can not be applied to the root element of the JSON value. +json.exception.out_of_range.406 | number overflow parsing '10E1000' | A parsed number could not be stored as without changing it to NaN or INF. +json.exception.out_of_range.407 | number overflow serializing '9223372036854775808' | UBJSON only supports integers numbers up to 9223372036854775807. | +json.exception.out_of_range.408 | excessive array size: 8658170730974374167 | The size (following `#`) of an UBJSON array or object exceeds the maximal capacity. | + +@liveexample{The following code shows how an `out_of_range` exception can be +caught.,out_of_range} + +@sa @ref exception for the base class of the library exceptions +@sa @ref parse_error for exceptions indicating a parse error +@sa @ref invalid_iterator for exceptions indicating errors with iterators +@sa @ref type_error for exceptions indicating executing a member function with + a wrong type +@sa @ref other_error for exceptions indicating other library errors + +@since version 3.0.0 +*/ +class out_of_range : public exception +{ + public: + static out_of_range create(int id_, const std::string& what_arg) + { + std::string w = exception::name("out_of_range", id_) + what_arg; + return out_of_range(id_, w.c_str()); + } + + private: + out_of_range(int id_, const char* what_arg) : exception(id_, what_arg) {} +}; + +/*! +@brief exception indicating other library errors + +This exception is thrown in case of errors that cannot be classified with the +other exception types. + +Exceptions have ids 5xx. + +name / id | example message | description +------------------------------ | --------------- | ------------------------- +json.exception.other_error.501 | unsuccessful: {"op":"test","path":"/baz", "value":"bar"} | A JSON Patch operation 'test' failed. The unsuccessful operation is also printed. + +@sa @ref exception for the base class of the library exceptions +@sa @ref parse_error for exceptions indicating a parse error +@sa @ref invalid_iterator for exceptions indicating errors with iterators +@sa @ref type_error for exceptions indicating executing a member function with + a wrong type +@sa @ref out_of_range for exceptions indicating access out of the defined range + +@liveexample{The following code shows how an `other_error` exception can be +caught.,other_error} + +@since version 3.0.0 +*/ +class other_error : public exception +{ + public: + static other_error create(int id_, const std::string& what_arg) + { + std::string w = exception::name("other_error", id_) + what_arg; + return other_error(id_, w.c_str()); + } + + private: + other_error(int id_, const char* what_arg) : exception(id_, what_arg) {} +}; +} +} + +// #include <nlohmann/detail/value_t.hpp> + + +#include <array> // array +#include <ciso646> // and +#include <cstddef> // size_t +#include <cstdint> // uint8_t + +namespace nlohmann +{ +namespace detail +{ +/////////////////////////// +// JSON type enumeration // +/////////////////////////// + +/*! +@brief the JSON type enumeration + +This enumeration collects the different JSON types. It is internally used to +distinguish the stored values, and the functions @ref basic_json::is_null(), +@ref basic_json::is_object(), @ref basic_json::is_array(), +@ref basic_json::is_string(), @ref basic_json::is_boolean(), +@ref basic_json::is_number() (with @ref basic_json::is_number_integer(), +@ref basic_json::is_number_unsigned(), and @ref basic_json::is_number_float()), +@ref basic_json::is_discarded(), @ref basic_json::is_primitive(), and +@ref basic_json::is_structured() rely on it. + +@note There are three enumeration entries (number_integer, number_unsigned, and +number_float), because the library distinguishes these three types for numbers: +@ref basic_json::number_unsigned_t is used for unsigned integers, +@ref basic_json::number_integer_t is used for signed integers, and +@ref basic_json::number_float_t is used for floating-point numbers or to +approximate integers which do not fit in the limits of their respective type. + +@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON +value with the default value for a given type + +@since version 1.0.0 +*/ +enum class value_t : std::uint8_t +{ + null, ///< null value + object, ///< object (unordered set of name/value pairs) + array, ///< array (ordered collection of values) + string, ///< string value + boolean, ///< boolean value + number_integer, ///< number value (signed integer) + number_unsigned, ///< number value (unsigned integer) + number_float, ///< number value (floating-point) + discarded ///< discarded by the the parser callback function +}; + +/*! +@brief comparison operator for JSON types + +Returns an ordering that is similar to Python: +- order: null < boolean < number < object < array < string +- furthermore, each type is not smaller than itself +- discarded values are not comparable + +@since version 1.0.0 +*/ +inline bool operator<(const value_t lhs, const value_t rhs) noexcept +{ + static constexpr std::array<std::uint8_t, 8> order = {{ + 0 /* null */, 3 /* object */, 4 /* array */, 5 /* string */, + 1 /* boolean */, 2 /* integer */, 2 /* unsigned */, 2 /* float */ + } + }; + + const auto l_index = static_cast<std::size_t>(lhs); + const auto r_index = static_cast<std::size_t>(rhs); + return l_index < order.size() and r_index < order.size() and order[l_index] < order[r_index]; +} +} +} + +// #include <nlohmann/detail/conversions/from_json.hpp> + + +#include <algorithm> // transform +#include <array> // array +#include <ciso646> // and, not +#include <forward_list> // forward_list +#include <iterator> // inserter, front_inserter, end +#include <map> // map +#include <string> // string +#include <tuple> // tuple, make_tuple +#include <type_traits> // is_arithmetic, is_same, is_enum, underlying_type, is_convertible +#include <unordered_map> // unordered_map +#include <utility> // pair, declval +#include <valarray> // valarray + +// #include <nlohmann/detail/exceptions.hpp> + +// #include <nlohmann/detail/macro_scope.hpp> + +// #include <nlohmann/detail/meta.hpp> + +// #include <nlohmann/detail/value_t.hpp> + + +namespace nlohmann +{ +namespace detail +{ +template<typename BasicJsonType> +void from_json(const BasicJsonType& j, typename std::nullptr_t& n) +{ + if (JSON_UNLIKELY(not j.is_null())) + { + JSON_THROW(type_error::create(302, "type must be null, but is " + std::string(j.type_name()))); + } + n = nullptr; +} + +// overloads for basic_json template parameters +template<typename BasicJsonType, typename ArithmeticType, + enable_if_t<std::is_arithmetic<ArithmeticType>::value and + not std::is_same<ArithmeticType, typename BasicJsonType::boolean_t>::value, + int> = 0> +void get_arithmetic_value(const BasicJsonType& j, ArithmeticType& val) +{ + switch (static_cast<value_t>(j)) + { + case value_t::number_unsigned: + { + val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>()); + break; + } + case value_t::number_integer: + { + val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_integer_t*>()); + break; + } + case value_t::number_float: + { + val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_float_t*>()); + break; + } + + default: + JSON_THROW(type_error::create(302, "type must be number, but is " + std::string(j.type_name()))); + } +} + +template<typename BasicJsonType> +void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b) +{ + if (JSON_UNLIKELY(not j.is_boolean())) + { + JSON_THROW(type_error::create(302, "type must be boolean, but is " + std::string(j.type_name()))); + } + b = *j.template get_ptr<const typename BasicJsonType::boolean_t*>(); +} + +template<typename BasicJsonType> +void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s) +{ + if (JSON_UNLIKELY(not j.is_string())) + { + JSON_THROW(type_error::create(302, "type must be string, but is " + std::string(j.type_name()))); + } + s = *j.template get_ptr<const typename BasicJsonType::string_t*>(); +} + +template < + typename BasicJsonType, typename CompatibleStringType, + enable_if_t < + is_compatible_string_type<BasicJsonType, CompatibleStringType>::value and + not std::is_same<typename BasicJsonType::string_t, + CompatibleStringType>::value, + int > = 0 > +void from_json(const BasicJsonType& j, CompatibleStringType& s) +{ + if (JSON_UNLIKELY(not j.is_string())) + { + JSON_THROW(type_error::create(302, "type must be string, but is " + std::string(j.type_name()))); + } + + s = *j.template get_ptr<const typename BasicJsonType::string_t*>(); +} + +template<typename BasicJsonType> +void from_json(const BasicJsonType& j, typename BasicJsonType::number_float_t& val) +{ + get_arithmetic_value(j, val); +} + +template<typename BasicJsonType> +void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val) +{ + get_arithmetic_value(j, val); +} + +template<typename BasicJsonType> +void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val) +{ + get_arithmetic_value(j, val); +} + +template<typename BasicJsonType, typename EnumType, + enable_if_t<std::is_enum<EnumType>::value, int> = 0> +void from_json(const BasicJsonType& j, EnumType& e) +{ + typename std::underlying_type<EnumType>::type val; + get_arithmetic_value(j, val); + e = static_cast<EnumType>(val); +} + +template<typename BasicJsonType> +void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr) +{ + if (JSON_UNLIKELY(not j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(j.type_name()))); + } + arr = *j.template get_ptr<const typename BasicJsonType::array_t*>(); +} + +// forward_list doesn't have an insert method +template<typename BasicJsonType, typename T, typename Allocator, + enable_if_t<std::is_convertible<BasicJsonType, T>::value, int> = 0> +void from_json(const BasicJsonType& j, std::forward_list<T, Allocator>& l) +{ + if (JSON_UNLIKELY(not j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(j.type_name()))); + } + std::transform(j.rbegin(), j.rend(), + std::front_inserter(l), [](const BasicJsonType & i) + { + return i.template get<T>(); + }); +} + +// valarray doesn't have an insert method +template<typename BasicJsonType, typename T, + enable_if_t<std::is_convertible<BasicJsonType, T>::value, int> = 0> +void from_json(const BasicJsonType& j, std::valarray<T>& l) +{ + if (JSON_UNLIKELY(not j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(j.type_name()))); + } + l.resize(j.size()); + std::copy(j.m_value.array->begin(), j.m_value.array->end(), std::begin(l)); +} + +template<typename BasicJsonType, typename CompatibleArrayType> +void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0> /*unused*/) +{ + using std::end; + + std::transform(j.begin(), j.end(), + std::inserter(arr, end(arr)), [](const BasicJsonType & i) + { + // get<BasicJsonType>() returns *this, this won't call a from_json + // method when value_type is BasicJsonType + return i.template get<typename CompatibleArrayType::value_type>(); + }); +} + +template<typename BasicJsonType, typename CompatibleArrayType> +auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1> /*unused*/) +-> decltype( + arr.reserve(std::declval<typename CompatibleArrayType::size_type>()), + void()) +{ + using std::end; + + arr.reserve(j.size()); + std::transform(j.begin(), j.end(), + std::inserter(arr, end(arr)), [](const BasicJsonType & i) + { + // get<BasicJsonType>() returns *this, this won't call a from_json + // method when value_type is BasicJsonType + return i.template get<typename CompatibleArrayType::value_type>(); + }); +} + +template<typename BasicJsonType, typename T, std::size_t N> +void from_json_array_impl(const BasicJsonType& j, std::array<T, N>& arr, priority_tag<2> /*unused*/) +{ + for (std::size_t i = 0; i < N; ++i) + { + arr[i] = j.at(i).template get<T>(); + } +} + +template < + typename BasicJsonType, typename CompatibleArrayType, + enable_if_t < + is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value and + not std::is_same<typename BasicJsonType::array_t, + CompatibleArrayType>::value and + std::is_constructible < + BasicJsonType, typename CompatibleArrayType::value_type >::value, + int > = 0 > +void from_json(const BasicJsonType& j, CompatibleArrayType& arr) +{ + if (JSON_UNLIKELY(not j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + + std::string(j.type_name()))); + } + + from_json_array_impl(j, arr, priority_tag<2> {}); +} + +template<typename BasicJsonType, typename CompatibleObjectType, + enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value, int> = 0> +void from_json(const BasicJsonType& j, CompatibleObjectType& obj) +{ + if (JSON_UNLIKELY(not j.is_object())) + { + JSON_THROW(type_error::create(302, "type must be object, but is " + std::string(j.type_name()))); + } + + auto inner_object = j.template get_ptr<const typename BasicJsonType::object_t*>(); + using value_type = typename CompatibleObjectType::value_type; + std::transform( + inner_object->begin(), inner_object->end(), + std::inserter(obj, obj.begin()), + [](typename BasicJsonType::object_t::value_type const & p) + { + return value_type(p.first, p.second.template get<typename CompatibleObjectType::mapped_type>()); + }); +} + +// overload for arithmetic types, not chosen for basic_json template arguments +// (BooleanType, etc..); note: Is it really necessary to provide explicit +// overloads for boolean_t etc. in case of a custom BooleanType which is not +// an arithmetic type? +template<typename BasicJsonType, typename ArithmeticType, + enable_if_t < + std::is_arithmetic<ArithmeticType>::value and + not std::is_same<ArithmeticType, typename BasicJsonType::number_unsigned_t>::value and + not std::is_same<ArithmeticType, typename BasicJsonType::number_integer_t>::value and + not std::is_same<ArithmeticType, typename BasicJsonType::number_float_t>::value and + not std::is_same<ArithmeticType, typename BasicJsonType::boolean_t>::value, + int> = 0> +void from_json(const BasicJsonType& j, ArithmeticType& val) +{ + switch (static_cast<value_t>(j)) + { + case value_t::number_unsigned: + { + val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>()); + break; + } + case value_t::number_integer: + { + val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_integer_t*>()); + break; + } + case value_t::number_float: + { + val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_float_t*>()); + break; + } + case value_t::boolean: + { + val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::boolean_t*>()); + break; + } + + default: + JSON_THROW(type_error::create(302, "type must be number, but is " + std::string(j.type_name()))); + } +} + +template<typename BasicJsonType, typename A1, typename A2> +void from_json(const BasicJsonType& j, std::pair<A1, A2>& p) +{ + p = {j.at(0).template get<A1>(), j.at(1).template get<A2>()}; +} + +template<typename BasicJsonType, typename Tuple, std::size_t... Idx> +void from_json_tuple_impl(const BasicJsonType& j, Tuple& t, index_sequence<Idx...>) +{ + t = std::make_tuple(j.at(Idx).template get<typename std::tuple_element<Idx, Tuple>::type>()...); +} + +template<typename BasicJsonType, typename... Args> +void from_json(const BasicJsonType& j, std::tuple<Args...>& t) +{ + from_json_tuple_impl(j, t, index_sequence_for<Args...> {}); +} + +template <typename BasicJsonType, typename Key, typename Value, typename Compare, typename Allocator, + typename = enable_if_t<not std::is_constructible< + typename BasicJsonType::string_t, Key>::value>> +void from_json(const BasicJsonType& j, std::map<Key, Value, Compare, Allocator>& m) +{ + if (JSON_UNLIKELY(not j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(j.type_name()))); + } + for (const auto& p : j) + { + if (JSON_UNLIKELY(not p.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(p.type_name()))); + } + m.emplace(p.at(0).template get<Key>(), p.at(1).template get<Value>()); + } +} + +template <typename BasicJsonType, typename Key, typename Value, typename Hash, typename KeyEqual, typename Allocator, + typename = enable_if_t<not std::is_constructible< + typename BasicJsonType::string_t, Key>::value>> +void from_json(const BasicJsonType& j, std::unordered_map<Key, Value, Hash, KeyEqual, Allocator>& m) +{ + if (JSON_UNLIKELY(not j.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(j.type_name()))); + } + for (const auto& p : j) + { + if (JSON_UNLIKELY(not p.is_array())) + { + JSON_THROW(type_error::create(302, "type must be array, but is " + std::string(p.type_name()))); + } + m.emplace(p.at(0).template get<Key>(), p.at(1).template get<Value>()); + } +} + +struct from_json_fn +{ + private: + template<typename BasicJsonType, typename T> + auto call(const BasicJsonType& j, T& val, priority_tag<1> /*unused*/) const + noexcept(noexcept(from_json(j, val))) + -> decltype(from_json(j, val), void()) + { + return from_json(j, val); + } + + template<typename BasicJsonType, typename T> + void call(const BasicJsonType& /*unused*/, T& /*unused*/, priority_tag<0> /*unused*/) const noexcept + { + static_assert(sizeof(BasicJsonType) == 0, + "could not find from_json() method in T's namespace"); +#ifdef _MSC_VER + // MSVC does not show a stacktrace for the above assert + using decayed = uncvref_t<T>; + static_assert(sizeof(typename decayed::force_msvc_stacktrace) == 0, + "forcing MSVC stacktrace to show which T we're talking about."); +#endif + } + + public: + template<typename BasicJsonType, typename T> + void operator()(const BasicJsonType& j, T& val) const + noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {}))) + { + return call(j, val, priority_tag<1> {}); + } +}; +} + +/// namespace to hold default `from_json` function +/// to see why this is required: +/// http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4381.html +namespace +{ +constexpr const auto& from_json = detail::static_const<detail::from_json_fn>::value; +} +} + +// #include <nlohmann/detail/conversions/to_json.hpp> + + +#include <ciso646> // or, and, not +#include <iterator> // begin, end +#include <tuple> // tuple, get +#include <type_traits> // is_same, is_constructible, is_floating_point, is_enum, underlying_type +#include <utility> // move, forward, declval, pair +#include <valarray> // valarray +#include <vector> // vector + +// #include <nlohmann/detail/meta.hpp> + +// #include <nlohmann/detail/value_t.hpp> + +// #include <nlohmann/detail/iterators/iteration_proxy.hpp> + + +#include <cstddef> // size_t +#include <string> // string, to_string +#include <iterator> // input_iterator_tag + +// #include <nlohmann/detail/value_t.hpp> + + +namespace nlohmann +{ +namespace detail +{ +/// proxy class for the items() function +template<typename IteratorType> class iteration_proxy +{ + private: + /// helper class for iteration + class iteration_proxy_internal + { + public: + using difference_type = std::ptrdiff_t; + using value_type = iteration_proxy_internal; + using pointer = iteration_proxy_internal*; + using reference = iteration_proxy_internal&; + using iterator_category = std::input_iterator_tag; + + private: + /// the iterator + IteratorType anchor; + /// an index for arrays (used to create key names) + std::size_t array_index = 0; + /// last stringified array index + mutable std::size_t array_index_last = 0; + /// a string representation of the array index + mutable std::string array_index_str = "0"; + /// an empty string (to return a reference for primitive values) + const std::string empty_str = ""; + + public: + explicit iteration_proxy_internal(IteratorType it) noexcept : anchor(it) {} + + iteration_proxy_internal(const iteration_proxy_internal&) = default; + iteration_proxy_internal& operator=(const iteration_proxy_internal&) = default; + + /// dereference operator (needed for range-based for) + iteration_proxy_internal& operator*() + { + return *this; + } + + /// increment operator (needed for range-based for) + iteration_proxy_internal& operator++() + { + ++anchor; + ++array_index; + + return *this; + } + + /// equality operator (needed for InputIterator) + bool operator==(const iteration_proxy_internal& o) const noexcept + { + return anchor == o.anchor; + } + + /// inequality operator (needed for range-based for) + bool operator!=(const iteration_proxy_internal& o) const noexcept + { + return anchor != o.anchor; + } + + /// return key of the iterator + const std::string& key() const + { + assert(anchor.m_object != nullptr); + + switch (anchor.m_object->type()) + { + // use integer array index as key + case value_t::array: + { + if (array_index != array_index_last) + { + array_index_str = std::to_string(array_index); + array_index_last = array_index; + } + return array_index_str; + } + + // use key from the object + case value_t::object: + return anchor.key(); + + // use an empty key for all primitive types + default: + return empty_str; + } + } + + /// return value of the iterator + typename IteratorType::reference value() const + { + return anchor.value(); + } + }; + + /// the container to iterate + typename IteratorType::reference container; + + public: + /// construct iteration proxy from a container + explicit iteration_proxy(typename IteratorType::reference cont) noexcept + : container(cont) {} + + /// return iterator begin (needed for range-based for) + iteration_proxy_internal begin() noexcept + { + return iteration_proxy_internal(container.begin()); + } + + /// return iterator end (needed for range-based for) + iteration_proxy_internal end() noexcept + { + return iteration_proxy_internal(container.end()); + } +}; +} +} + + +namespace nlohmann +{ +namespace detail +{ +////////////////// +// constructors // +////////////////// + +template<value_t> struct external_constructor; + +template<> +struct external_constructor<value_t::boolean> +{ + template<typename BasicJsonType> + static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept + { + j.m_type = value_t::boolean; + j.m_value = b; + j.assert_invariant(); + } +}; + +template<> +struct external_constructor<value_t::string> +{ + template<typename BasicJsonType> + static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s) + { + j.m_type = value_t::string; + j.m_value = s; + j.assert_invariant(); + } + + template<typename BasicJsonType> + static void construct(BasicJsonType& j, typename BasicJsonType::string_t&& s) + { + j.m_type = value_t::string; + j.m_value = std::move(s); + j.assert_invariant(); + } + + template<typename BasicJsonType, typename CompatibleStringType, + enable_if_t<not std::is_same<CompatibleStringType, typename BasicJsonType::string_t>::value, + int> = 0> + static void construct(BasicJsonType& j, const CompatibleStringType& str) + { + j.m_type = value_t::string; + j.m_value.string = j.template create<typename BasicJsonType::string_t>(str); + j.assert_invariant(); + } +}; + +template<> +struct external_constructor<value_t::number_float> +{ + template<typename BasicJsonType> + static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept + { + j.m_type = value_t::number_float; + j.m_value = val; + j.assert_invariant(); + } +}; + +template<> +struct external_constructor<value_t::number_unsigned> +{ + template<typename BasicJsonType> + static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept + { + j.m_type = value_t::number_unsigned; + j.m_value = val; + j.assert_invariant(); + } +}; + +template<> +struct external_constructor<value_t::number_integer> +{ + template<typename BasicJsonType> + static void construct(BasicJsonType& j, typename BasicJsonType::number_integer_t val) noexcept + { + j.m_type = value_t::number_integer; + j.m_value = val; + j.assert_invariant(); + } +}; + +template<> +struct external_constructor<value_t::array> +{ + template<typename BasicJsonType> + static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr) + { + j.m_type = value_t::array; + j.m_value = arr; + j.assert_invariant(); + } + + template<typename BasicJsonType> + static void construct(BasicJsonType& j, typename BasicJsonType::array_t&& arr) + { + j.m_type = value_t::array; + j.m_value = std::move(arr); + j.assert_invariant(); + } + + template<typename BasicJsonType, typename CompatibleArrayType, + enable_if_t<not std::is_same<CompatibleArrayType, typename BasicJsonType::array_t>::value, + int> = 0> + static void construct(BasicJsonType& j, const CompatibleArrayType& arr) + { + using std::begin; + using std::end; + j.m_type = value_t::array; + j.m_value.array = j.template create<typename BasicJsonType::array_t>(begin(arr), end(arr)); + j.assert_invariant(); + } + + template<typename BasicJsonType> + static void construct(BasicJsonType& j, const std::vector<bool>& arr) + { + j.m_type = value_t::array; + j.m_value = value_t::array; + j.m_value.array->reserve(arr.size()); + for (const bool x : arr) + { + j.m_value.array->push_back(x); + } + j.assert_invariant(); + } + + template<typename BasicJsonType, typename T, + enable_if_t<std::is_convertible<T, BasicJsonType>::value, int> = 0> + static void construct(BasicJsonType& j, const std::valarray<T>& arr) + { + j.m_type = value_t::array; + j.m_value = value_t::array; + j.m_value.array->resize(arr.size()); + std::copy(std::begin(arr), std::end(arr), j.m_value.array->begin()); + j.assert_invariant(); + } +}; + +template<> +struct external_constructor<value_t::object> +{ + template<typename BasicJsonType> + static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj) + { + j.m_type = value_t::object; + j.m_value = obj; + j.assert_invariant(); + } + + template<typename BasicJsonType> + static void construct(BasicJsonType& j, typename BasicJsonType::object_t&& obj) + { + j.m_type = value_t::object; + j.m_value = std::move(obj); + j.assert_invariant(); + } + + template<typename BasicJsonType, typename CompatibleObjectType, + enable_if_t<not std::is_same<CompatibleObjectType, typename BasicJsonType::object_t>::value, int> = 0> + static void construct(BasicJsonType& j, const CompatibleObjectType& obj) + { + using std::begin; + using std::end; + + j.m_type = value_t::object; + j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj)); + j.assert_invariant(); + } +}; + +///////////// +// to_json // +///////////// + +template<typename BasicJsonType, typename T, + enable_if_t<std::is_same<T, typename BasicJsonType::boolean_t>::value, int> = 0> +void to_json(BasicJsonType& j, T b) noexcept +{ + external_constructor<value_t::boolean>::construct(j, b); +} + +template<typename BasicJsonType, typename CompatibleString, + enable_if_t<std::is_constructible<typename BasicJsonType::string_t, CompatibleString>::value, int> = 0> +void to_json(BasicJsonType& j, const CompatibleString& s) +{ + external_constructor<value_t::string>::construct(j, s); +} + +template<typename BasicJsonType> +void to_json(BasicJsonType& j, typename BasicJsonType::string_t&& s) +{ + external_constructor<value_t::string>::construct(j, std::move(s)); +} + +template<typename BasicJsonType, typename FloatType, + enable_if_t<std::is_floating_point<FloatType>::value, int> = 0> +void to_json(BasicJsonType& j, FloatType val) noexcept +{ + external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val)); +} + +template<typename BasicJsonType, typename CompatibleNumberUnsignedType, + enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_unsigned_t, CompatibleNumberUnsignedType>::value, int> = 0> +void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept +{ + external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename BasicJsonType::number_unsigned_t>(val)); +} + +template<typename BasicJsonType, typename CompatibleNumberIntegerType, + enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t, CompatibleNumberIntegerType>::value, int> = 0> +void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept +{ + external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val)); +} + +template<typename BasicJsonType, typename EnumType, + enable_if_t<std::is_enum<EnumType>::value, int> = 0> +void to_json(BasicJsonType& j, EnumType e) noexcept +{ + using underlying_type = typename std::underlying_type<EnumType>::type; + external_constructor<value_t::number_integer>::construct(j, static_cast<underlying_type>(e)); +} + +template<typename BasicJsonType> +void to_json(BasicJsonType& j, const std::vector<bool>& e) +{ + external_constructor<value_t::array>::construct(j, e); +} + +template<typename BasicJsonType, typename CompatibleArrayType, + enable_if_t<is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value or + std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value, + int> = 0> +void to_json(BasicJsonType& j, const CompatibleArrayType& arr) +{ + external_constructor<value_t::array>::construct(j, arr); +} + +template<typename BasicJsonType, typename T, + enable_if_t<std::is_convertible<T, BasicJsonType>::value, int> = 0> +void to_json(BasicJsonType& j, const std::valarray<T>& arr) +{ + external_constructor<value_t::array>::construct(j, std::move(arr)); +} + +template<typename BasicJsonType> +void to_json(BasicJsonType& j, typename BasicJsonType::array_t&& arr) +{ + external_constructor<value_t::array>::construct(j, std::move(arr)); +} + +template<typename BasicJsonType, typename CompatibleObjectType, + enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value, int> = 0> +void to_json(BasicJsonType& j, const CompatibleObjectType& obj) +{ + external_constructor<value_t::object>::construct(j, obj); +} + +template<typename BasicJsonType> +void to_json(BasicJsonType& j, typename BasicJsonType::object_t&& obj) +{ + external_constructor<value_t::object>::construct(j, std::move(obj)); +} + +template<typename BasicJsonType, typename T, std::size_t N, + enable_if_t<not std::is_constructible<typename BasicJsonType::string_t, T (&)[N]>::value, int> = 0> +void to_json(BasicJsonType& j, T (&arr)[N]) +{ + external_constructor<value_t::array>::construct(j, arr); +} + +template<typename BasicJsonType, typename... Args> +void to_json(BasicJsonType& j, const std::pair<Args...>& p) +{ + j = {p.first, p.second}; +} + +// for https://github.com/nlohmann/json/pull/1134 +template<typename BasicJsonType, typename T, + enable_if_t<std::is_same<T, typename iteration_proxy<typename BasicJsonType::iterator>::iteration_proxy_internal>::value, int> = 0> +void to_json(BasicJsonType& j, T b) noexcept +{ + j = {{b.key(), b.value()}}; +} + +template<typename BasicJsonType, typename Tuple, std::size_t... Idx> +void to_json_tuple_impl(BasicJsonType& j, const Tuple& t, index_sequence<Idx...>) +{ + j = {std::get<Idx>(t)...}; +} + +template<typename BasicJsonType, typename... Args> +void to_json(BasicJsonType& j, const std::tuple<Args...>& t) +{ + to_json_tuple_impl(j, t, index_sequence_for<Args...> {}); +} + +struct to_json_fn +{ + private: + template<typename BasicJsonType, typename T> + auto call(BasicJsonType& j, T&& val, priority_tag<1> /*unused*/) const noexcept(noexcept(to_json(j, std::forward<T>(val)))) + -> decltype(to_json(j, std::forward<T>(val)), void()) + { + return to_json(j, std::forward<T>(val)); + } + + template<typename BasicJsonType, typename T> + void call(BasicJsonType& /*unused*/, T&& /*unused*/, priority_tag<0> /*unused*/) const noexcept + { + static_assert(sizeof(BasicJsonType) == 0, + "could not find to_json() method in T's namespace"); + +#ifdef _MSC_VER + // MSVC does not show a stacktrace for the above assert + using decayed = uncvref_t<T>; + static_assert(sizeof(typename decayed::force_msvc_stacktrace) == 0, + "forcing MSVC stacktrace to show which T we're talking about."); +#endif + } + + public: + template<typename BasicJsonType, typename T> + void operator()(BasicJsonType& j, T&& val) const + noexcept(noexcept(std::declval<to_json_fn>().call(j, std::forward<T>(val), priority_tag<1> {}))) + { + return call(j, std::forward<T>(val), priority_tag<1> {}); + } +}; +} + +/// namespace to hold default `to_json` function +namespace +{ +constexpr const auto& to_json = detail::static_const<detail::to_json_fn>::value; +} +} + +// #include <nlohmann/detail/input/input_adapters.hpp> + + +#include <cassert> // assert +#include <cstddef> // size_t +#include <cstring> // strlen +#include <istream> // istream +#include <iterator> // begin, end, iterator_traits, random_access_iterator_tag, distance, next +#include <memory> // shared_ptr, make_shared, addressof +#include <numeric> // accumulate +#include <string> // string, char_traits +#include <type_traits> // enable_if, is_base_of, is_pointer, is_integral, remove_pointer +#include <utility> // pair, declval + +// #include <nlohmann/detail/macro_scope.hpp> + + +namespace nlohmann +{ +namespace detail +{ +/// the supported input formats +enum class input_format_t { json, cbor, msgpack, ubjson }; + +//////////////////// +// input adapters // +//////////////////// + +/*! +@brief abstract input adapter interface + +Produces a stream of std::char_traits<char>::int_type characters from a +std::istream, a buffer, or some other input type. Accepts the return of +exactly one non-EOF character for future input. The int_type characters +returned consist of all valid char values as positive values (typically +unsigned char), plus an EOF value outside that range, specified by the value +of the function std::char_traits<char>::eof(). This value is typically -1, but +could be any arbitrary value which is not a valid char value. +*/ +struct input_adapter_protocol +{ + /// get a character [0,255] or std::char_traits<char>::eof(). + virtual std::char_traits<char>::int_type get_character() = 0; + virtual ~input_adapter_protocol() = default; +}; + +/// a type to simplify interfaces +using input_adapter_t = std::shared_ptr<input_adapter_protocol>; + +/*! +Input adapter for a (caching) istream. Ignores a UFT Byte Order Mark at +beginning of input. Does not support changing the underlying std::streambuf +in mid-input. Maintains underlying std::istream and std::streambuf to support +subsequent use of standard std::istream operations to process any input +characters following those used in parsing the JSON input. Clears the +std::istream flags; any input errors (e.g., EOF) will be detected by the first +subsequent call for input from the std::istream. +*/ +class input_stream_adapter : public input_adapter_protocol +{ + public: + ~input_stream_adapter() override + { + // clear stream flags; we use underlying streambuf I/O, do not + // maintain ifstream flags + is.clear(); + } + + explicit input_stream_adapter(std::istream& i) + : is(i), sb(*i.rdbuf()) + {} + + // delete because of pointer members + input_stream_adapter(const input_stream_adapter&) = delete; + input_stream_adapter& operator=(input_stream_adapter&) = delete; + + // std::istream/std::streambuf use std::char_traits<char>::to_int_type, to + // ensure that std::char_traits<char>::eof() and the character 0xFF do not + // end up as the same value, eg. 0xFFFFFFFF. + std::char_traits<char>::int_type get_character() override + { + return sb.sbumpc(); + } + + private: + /// the associated input stream + std::istream& is; + std::streambuf& sb; +}; + +/// input adapter for buffer input +class input_buffer_adapter : public input_adapter_protocol +{ + public: + input_buffer_adapter(const char* b, const std::size_t l) + : cursor(b), limit(b + l) + {} + + // delete because of pointer members + input_buffer_adapter(const input_buffer_adapter&) = delete; + input_buffer_adapter& operator=(input_buffer_adapter&) = delete; + + std::char_traits<char>::int_type get_character() noexcept override + { + if (JSON_LIKELY(cursor < limit)) + { + return std::char_traits<char>::to_int_type(*(cursor++)); + } + + return std::char_traits<char>::eof(); + } + + private: + /// pointer to the current character + const char* cursor; + /// pointer past the last character + const char* const limit; +}; + +template<typename WideStringType> +class wide_string_input_adapter : public input_adapter_protocol +{ + public: + explicit wide_string_input_adapter(const WideStringType& w) : str(w) {} + + std::char_traits<char>::int_type get_character() noexcept override + { + // check if buffer needs to be filled + if (utf8_bytes_index == utf8_bytes_filled) + { + if (sizeof(typename WideStringType::value_type) == 2) + { + fill_buffer_utf16(); + } + else + { + fill_buffer_utf32(); + } + + assert(utf8_bytes_filled > 0); + assert(utf8_bytes_index == 0); + } + + // use buffer + assert(utf8_bytes_filled > 0); + assert(utf8_bytes_index < utf8_bytes_filled); + return utf8_bytes[utf8_bytes_index++]; + } + + private: + void fill_buffer_utf16() + { + utf8_bytes_index = 0; + + if (current_wchar == str.size()) + { + utf8_bytes[0] = std::char_traits<char>::eof(); + utf8_bytes_filled = 1; + } + else + { + // get the current character + const int wc = static_cast<int>(str[current_wchar++]); + + // UTF-16 to UTF-8 encoding + if (wc < 0x80) + { + utf8_bytes[0] = wc; + utf8_bytes_filled = 1; + } + else if (wc <= 0x7FF) + { + utf8_bytes[0] = 0xC0 | ((wc >> 6)); + utf8_bytes[1] = 0x80 | (wc & 0x3F); + utf8_bytes_filled = 2; + } + else if (0xD800 > wc or wc >= 0xE000) + { + utf8_bytes[0] = 0xE0 | ((wc >> 12)); + utf8_bytes[1] = 0x80 | ((wc >> 6) & 0x3F); + utf8_bytes[2] = 0x80 | (wc & 0x3F); + utf8_bytes_filled = 3; + } + else + { + if (current_wchar < str.size()) + { + const int wc2 = static_cast<int>(str[current_wchar++]); + const int charcode = 0x10000 + (((wc & 0x3FF) << 10) | (wc2 & 0x3FF)); + utf8_bytes[0] = 0xf0 | (charcode >> 18); + utf8_bytes[1] = 0x80 | ((charcode >> 12) & 0x3F); + utf8_bytes[2] = 0x80 | ((charcode >> 6) & 0x3F); + utf8_bytes[3] = 0x80 | (charcode & 0x3F); + utf8_bytes_filled = 4; + } + else + { + // unknown character + ++current_wchar; + utf8_bytes[0] = wc; + utf8_bytes_filled = 1; + } + } + } + } + + void fill_buffer_utf32() + { + utf8_bytes_index = 0; + + if (current_wchar == str.size()) + { + utf8_bytes[0] = std::char_traits<char>::eof(); + utf8_bytes_filled = 1; + } + else + { + // get the current character + const int wc = static_cast<int>(str[current_wchar++]); + + // UTF-32 to UTF-8 encoding + if (wc < 0x80) + { + utf8_bytes[0] = wc; + utf8_bytes_filled = 1; + } + else if (wc <= 0x7FF) + { + utf8_bytes[0] = 0xC0 | ((wc >> 6) & 0x1F); + utf8_bytes[1] = 0x80 | (wc & 0x3F); + utf8_bytes_filled = 2; + } + else if (wc <= 0xFFFF) + { + utf8_bytes[0] = 0xE0 | ((wc >> 12) & 0x0F); + utf8_bytes[1] = 0x80 | ((wc >> 6) & 0x3F); + utf8_bytes[2] = 0x80 | (wc & 0x3F); + utf8_bytes_filled = 3; + } + else if (wc <= 0x10FFFF) + { + utf8_bytes[0] = 0xF0 | ((wc >> 18 ) & 0x07); + utf8_bytes[1] = 0x80 | ((wc >> 12) & 0x3F); + utf8_bytes[2] = 0x80 | ((wc >> 6) & 0x3F); + utf8_bytes[3] = 0x80 | (wc & 0x3F); + utf8_bytes_filled = 4; + } + else + { + // unknown character + utf8_bytes[0] = wc; + utf8_bytes_filled = 1; + } + } + } + + private: + /// the wstring to process + const WideStringType& str; + + /// index of the current wchar in str + std::size_t current_wchar = 0; + + /// a buffer for UTF-8 bytes + std::array<std::char_traits<char>::int_type, 4> utf8_bytes = {{0, 0, 0, 0}}; + + /// index to the utf8_codes array for the next valid byte + std::size_t utf8_bytes_index = 0; + /// number of valid bytes in the utf8_codes array + std::size_t utf8_bytes_filled = 0; +}; + +class input_adapter +{ + public: + // native support + + /// input adapter for input stream + input_adapter(std::istream& i) + : ia(std::make_shared<input_stream_adapter>(i)) {} + + /// input adapter for input stream + input_adapter(std::istream&& i) + : ia(std::make_shared<input_stream_adapter>(i)) {} + + input_adapter(const std::wstring& ws) + : ia(std::make_shared<wide_string_input_adapter<std::wstring>>(ws)) {} + + input_adapter(const std::u16string& ws) + : ia(std::make_shared<wide_string_input_adapter<std::u16string>>(ws)) {} + + input_adapter(const std::u32string& ws) + : ia(std::make_shared<wide_string_input_adapter<std::u32string>>(ws)) {} + + /// input adapter for buffer + template<typename CharT, + typename std::enable_if< + std::is_pointer<CharT>::value and + std::is_integral<typename std::remove_pointer<CharT>::type>::value and + sizeof(typename std::remove_pointer<CharT>::type) == 1, + int>::type = 0> + input_adapter(CharT b, std::size_t l) + : ia(std::make_shared<input_buffer_adapter>(reinterpret_cast<const char*>(b), l)) {} + + // derived support + + /// input adapter for string literal + template<typename CharT, + typename std::enable_if< + std::is_pointer<CharT>::value and + std::is_integral<typename std::remove_pointer<CharT>::type>::value and + sizeof(typename std::remove_pointer<CharT>::type) == 1, + int>::type = 0> + input_adapter(CharT b) + : input_adapter(reinterpret_cast<const char*>(b), + std::strlen(reinterpret_cast<const char*>(b))) {} + + /// input adapter for iterator range with contiguous storage + template<class IteratorType, + typename std::enable_if< + std::is_same<typename std::iterator_traits<IteratorType>::iterator_category, std::random_access_iterator_tag>::value, + int>::type = 0> + input_adapter(IteratorType first, IteratorType last) + { + // assertion to check that the iterator range is indeed contiguous, + // see http://stackoverflow.com/a/35008842/266378 for more discussion + assert(std::accumulate( + first, last, std::pair<bool, int>(true, 0), + [&first](std::pair<bool, int> res, decltype(*first) val) + { + res.first &= (val == *(std::next(std::addressof(*first), res.second++))); + return res; + }).first); + + // assertion to check that each element is 1 byte long + static_assert( + sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1, + "each element in the iterator range must have the size of 1 byte"); + + const auto len = static_cast<size_t>(std::distance(first, last)); + if (JSON_LIKELY(len > 0)) + { + // there is at least one element: use the address of first + ia = std::make_shared<input_buffer_adapter>(reinterpret_cast<const char*>(&(*first)), len); + } + else + { + // the address of first cannot be used: use nullptr + ia = std::make_shared<input_buffer_adapter>(nullptr, len); + } + } + + /// input adapter for array + template<class T, std::size_t N> + input_adapter(T (&array)[N]) + : input_adapter(std::begin(array), std::end(array)) {} + + /// input adapter for contiguous container + template<class ContiguousContainer, typename + std::enable_if<not std::is_pointer<ContiguousContainer>::value and + std::is_base_of<std::random_access_iterator_tag, typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value, + int>::type = 0> + input_adapter(const ContiguousContainer& c) + : input_adapter(std::begin(c), std::end(c)) {} + + operator input_adapter_t() + { + return ia; + } + + private: + /// the actual adapter + input_adapter_t ia = nullptr; +}; +} +} + +// #include <nlohmann/detail/input/lexer.hpp> + + +#include <clocale> // localeconv +#include <cstddef> // size_t +#include <cstdlib> // strtof, strtod, strtold, strtoll, strtoull +#include <cstdio> // snprintf +#include <initializer_list> // initializer_list +#include <string> // char_traits, string +#include <vector> // vector + +// #include <nlohmann/detail/macro_scope.hpp> + +// #include <nlohmann/detail/input/input_adapters.hpp> + + +namespace nlohmann +{ +namespace detail +{ +/////////// +// lexer // +/////////// + +/*! +@brief lexical analysis + +This class organizes the lexical analysis during JSON deserialization. +*/ +template<typename BasicJsonType> +class lexer +{ + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + + public: + /// token types for the parser + enum class token_type + { + uninitialized, ///< indicating the scanner is uninitialized + literal_true, ///< the `true` literal + literal_false, ///< the `false` literal + literal_null, ///< the `null` literal + value_string, ///< a string -- use get_string() for actual value + value_unsigned, ///< an unsigned integer -- use get_number_unsigned() for actual value + value_integer, ///< a signed integer -- use get_number_integer() for actual value + value_float, ///< an floating point number -- use get_number_float() for actual value + begin_array, ///< the character for array begin `[` + begin_object, ///< the character for object begin `{` + end_array, ///< the character for array end `]` + end_object, ///< the character for object end `}` + name_separator, ///< the name separator `:` + value_separator, ///< the value separator `,` + parse_error, ///< indicating a parse error + end_of_input, ///< indicating the end of the input buffer + literal_or_value ///< a literal or the begin of a value (only for diagnostics) + }; + + /// return name of values of type token_type (only used for errors) + static const char* token_type_name(const token_type t) noexcept + { + switch (t) + { + case token_type::uninitialized: + return "<uninitialized>"; + case token_type::literal_true: + return "true literal"; + case token_type::literal_false: + return "false literal"; + case token_type::literal_null: + return "null literal"; + case token_type::value_string: + return "string literal"; + case lexer::token_type::value_unsigned: + case lexer::token_type::value_integer: + case lexer::token_type::value_float: + return "number literal"; + case token_type::begin_array: + return "'['"; + case token_type::begin_object: + return "'{'"; + case token_type::end_array: + return "']'"; + case token_type::end_object: + return "'}'"; + case token_type::name_separator: + return "':'"; + case token_type::value_separator: + return "','"; + case token_type::parse_error: + return "<parse error>"; + case token_type::end_of_input: + return "end of input"; + case token_type::literal_or_value: + return "'[', '{', or a literal"; + default: // catch non-enum values + return "unknown token"; // LCOV_EXCL_LINE + } + } + + explicit lexer(detail::input_adapter_t&& adapter) + : ia(std::move(adapter)), decimal_point_char(get_decimal_point()) {} + + // delete because of pointer members + lexer(const lexer&) = delete; + lexer& operator=(lexer&) = delete; + + private: + ///////////////////// + // locales + ///////////////////// + + /// return the locale-dependent decimal point + static char get_decimal_point() noexcept + { + const auto loc = localeconv(); + assert(loc != nullptr); + return (loc->decimal_point == nullptr) ? '.' : *(loc->decimal_point); + } + + ///////////////////// + // scan functions + ///////////////////// + + /*! + @brief get codepoint from 4 hex characters following `\u` + + For input "\u c1 c2 c3 c4" the codepoint is: + (c1 * 0x1000) + (c2 * 0x0100) + (c3 * 0x0010) + c4 + = (c1 << 12) + (c2 << 8) + (c3 << 4) + (c4 << 0) + + Furthermore, the possible characters '0'..'9', 'A'..'F', and 'a'..'f' + must be converted to the integers 0x0..0x9, 0xA..0xF, 0xA..0xF, resp. The + conversion is done by subtracting the offset (0x30, 0x37, and 0x57) + between the ASCII value of the character and the desired integer value. + + @return codepoint (0x0000..0xFFFF) or -1 in case of an error (e.g. EOF or + non-hex character) + */ + int get_codepoint() + { + // this function only makes sense after reading `\u` + assert(current == 'u'); + int codepoint = 0; + + const auto factors = { 12, 8, 4, 0 }; + for (const auto factor : factors) + { + get(); + + if (current >= '0' and current <= '9') + { + codepoint += ((current - 0x30) << factor); + } + else if (current >= 'A' and current <= 'F') + { + codepoint += ((current - 0x37) << factor); + } + else if (current >= 'a' and current <= 'f') + { + codepoint += ((current - 0x57) << factor); + } + else + { + return -1; + } + } + + assert(0x0000 <= codepoint and codepoint <= 0xFFFF); + return codepoint; + } + + /*! + @brief check if the next byte(s) are inside a given range + + Adds the current byte and, for each passed range, reads a new byte and + checks if it is inside the range. If a violation was detected, set up an + error message and return false. Otherwise, return true. + + @param[in] ranges list of integers; interpreted as list of pairs of + inclusive lower and upper bound, respectively + + @pre The passed list @a ranges must have 2, 4, or 6 elements; that is, + 1, 2, or 3 pairs. This precondition is enforced by an assertion. + + @return true if and only if no range violation was detected + */ + bool next_byte_in_range(std::initializer_list<int> ranges) + { + assert(ranges.size() == 2 or ranges.size() == 4 or ranges.size() == 6); + add(current); + + for (auto range = ranges.begin(); range != ranges.end(); ++range) + { + get(); + if (JSON_LIKELY(*range <= current and current <= *(++range))) + { + add(current); + } + else + { + error_message = "invalid string: ill-formed UTF-8 byte"; + return false; + } + } + + return true; + } + + /*! + @brief scan a string literal + + This function scans a string according to Sect. 7 of RFC 7159. While + scanning, bytes are escaped and copied into buffer token_buffer. Then the + function returns successfully, token_buffer is *not* null-terminated (as it + may contain \0 bytes), and token_buffer.size() is the number of bytes in the + string. + + @return token_type::value_string if string could be successfully scanned, + token_type::parse_error otherwise + + @note In case of errors, variable error_message contains a textual + description. + */ + token_type scan_string() + { + // reset token_buffer (ignore opening quote) + reset(); + + // we entered the function by reading an open quote + assert(current == '\"'); + + while (true) + { + // get next character + switch (get()) + { + // end of file while parsing string + case std::char_traits<char>::eof(): + { + error_message = "invalid string: missing closing quote"; + return token_type::parse_error; + } + + // closing quote + case '\"': + { + return token_type::value_string; + } + + // escapes + case '\\': + { + switch (get()) + { + // quotation mark + case '\"': + add('\"'); + break; + // reverse solidus + case '\\': + add('\\'); + break; + // solidus + case '/': + add('/'); + break; + // backspace + case 'b': + add('\b'); + break; + // form feed + case 'f': + add('\f'); + break; + // line feed + case 'n': + add('\n'); + break; + // carriage return + case 'r': + add('\r'); + break; + // tab + case 't': + add('\t'); + break; + + // unicode escapes + case 'u': + { + const int codepoint1 = get_codepoint(); + int codepoint = codepoint1; // start with codepoint1 + + if (JSON_UNLIKELY(codepoint1 == -1)) + { + error_message = "invalid string: '\\u' must be followed by 4 hex digits"; + return token_type::parse_error; + } + + // check if code point is a high surrogate + if (0xD800 <= codepoint1 and codepoint1 <= 0xDBFF) + { + // expect next \uxxxx entry + if (JSON_LIKELY(get() == '\\' and get() == 'u')) + { + const int codepoint2 = get_codepoint(); + + if (JSON_UNLIKELY(codepoint2 == -1)) + { + error_message = "invalid string: '\\u' must be followed by 4 hex digits"; + return token_type::parse_error; + } + + // check if codepoint2 is a low surrogate + if (JSON_LIKELY(0xDC00 <= codepoint2 and codepoint2 <= 0xDFFF)) + { + // overwrite codepoint + codepoint = + // high surrogate occupies the most significant 22 bits + (codepoint1 << 10) + // low surrogate occupies the least significant 15 bits + + codepoint2 + // there is still the 0xD800, 0xDC00 and 0x10000 noise + // in the result so we have to subtract with: + // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00 + - 0x35FDC00; + } + else + { + error_message = "invalid string: surrogate U+DC00..U+DFFF must be followed by U+DC00..U+DFFF"; + return token_type::parse_error; + } + } + else + { + error_message = "invalid string: surrogate U+DC00..U+DFFF must be followed by U+DC00..U+DFFF"; + return token_type::parse_error; + } + } + else + { + if (JSON_UNLIKELY(0xDC00 <= codepoint1 and codepoint1 <= 0xDFFF)) + { + error_message = "invalid string: surrogate U+DC00..U+DFFF must follow U+D800..U+DBFF"; + return token_type::parse_error; + } + } + + // result of the above calculation yields a proper codepoint + assert(0x00 <= codepoint and codepoint <= 0x10FFFF); + + // translate codepoint into bytes + if (codepoint < 0x80) + { + // 1-byte characters: 0xxxxxxx (ASCII) + add(codepoint); + } + else if (codepoint <= 0x7FF) + { + // 2-byte characters: 110xxxxx 10xxxxxx + add(0xC0 | (codepoint >> 6)); + add(0x80 | (codepoint & 0x3F)); + } + else if (codepoint <= 0xFFFF) + { + // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx + add(0xE0 | (codepoint >> 12)); + add(0x80 | ((codepoint >> 6) & 0x3F)); + add(0x80 | (codepoint & 0x3F)); + } + else + { + // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx + add(0xF0 | (codepoint >> 18)); + add(0x80 | ((codepoint >> 12) & 0x3F)); + add(0x80 | ((codepoint >> 6) & 0x3F)); + add(0x80 | (codepoint & 0x3F)); + } + + break; + } + + // other characters after escape + default: + error_message = "invalid string: forbidden character after backslash"; + return token_type::parse_error; + } + + break; + } + + // invalid control characters + case 0x00: + case 0x01: + case 0x02: + case 0x03: + case 0x04: + case 0x05: + case 0x06: + case 0x07: + case 0x08: + case 0x09: + case 0x0A: + case 0x0B: + case 0x0C: + case 0x0D: + case 0x0E: + case 0x0F: + case 0x10: + case 0x11: + case 0x12: + case 0x13: + case 0x14: + case 0x15: + case 0x16: + case 0x17: + case 0x18: + case 0x19: + case 0x1A: + case 0x1B: + case 0x1C: + case 0x1D: + case 0x1E: + case 0x1F: + { + error_message = "invalid string: control character must be escaped"; + return token_type::parse_error; + } + + // U+0020..U+007F (except U+0022 (quote) and U+005C (backspace)) + case 0x20: + case 0x21: + case 0x23: + case 0x24: + case 0x25: + case 0x26: + case 0x27: + case 0x28: + case 0x29: + case 0x2A: + case 0x2B: + case 0x2C: + case 0x2D: + case 0x2E: + case 0x2F: + case 0x30: + case 0x31: + case 0x32: + case 0x33: + case 0x34: + case 0x35: + case 0x36: + case 0x37: + case 0x38: + case 0x39: + case 0x3A: + case 0x3B: + case 0x3C: + case 0x3D: + case 0x3E: + case 0x3F: + case 0x40: + case 0x41: + case 0x42: + case 0x43: + case 0x44: + case 0x45: + case 0x46: + case 0x47: + case 0x48: + case 0x49: + case 0x4A: + case 0x4B: + case 0x4C: + case 0x4D: + case 0x4E: + case 0x4F: + case 0x50: + case 0x51: + case 0x52: + case 0x53: + case 0x54: + case 0x55: + case 0x56: + case 0x57: + case 0x58: + case 0x59: + case 0x5A: + case 0x5B: + case 0x5D: + case 0x5E: + case 0x5F: + case 0x60: + case 0x61: + case 0x62: + case 0x63: + case 0x64: + case 0x65: + case 0x66: + case 0x67: + case 0x68: + case 0x69: + case 0x6A: + case 0x6B: + case 0x6C: + case 0x6D: + case 0x6E: + case 0x6F: + case 0x70: + case 0x71: + case 0x72: + case 0x73: + case 0x74: + case 0x75: + case 0x76: + case 0x77: + case 0x78: + case 0x79: + case 0x7A: + case 0x7B: + case 0x7C: + case 0x7D: + case 0x7E: + case 0x7F: + { + add(current); + break; + } + + // U+0080..U+07FF: bytes C2..DF 80..BF + case 0xC2: + case 0xC3: + case 0xC4: + case 0xC5: + case 0xC6: + case 0xC7: + case 0xC8: + case 0xC9: + case 0xCA: + case 0xCB: + case 0xCC: + case 0xCD: + case 0xCE: + case 0xCF: + case 0xD0: + case 0xD1: + case 0xD2: + case 0xD3: + case 0xD4: + case 0xD5: + case 0xD6: + case 0xD7: + case 0xD8: + case 0xD9: + case 0xDA: + case 0xDB: + case 0xDC: + case 0xDD: + case 0xDE: + case 0xDF: + { + if (JSON_UNLIKELY(not next_byte_in_range({0x80, 0xBF}))) + { + return token_type::parse_error; + } + break; + } + + // U+0800..U+0FFF: bytes E0 A0..BF 80..BF + case 0xE0: + { + if (JSON_UNLIKELY(not (next_byte_in_range({0xA0, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+1000..U+CFFF: bytes E1..EC 80..BF 80..BF + // U+E000..U+FFFF: bytes EE..EF 80..BF 80..BF + case 0xE1: + case 0xE2: + case 0xE3: + case 0xE4: + case 0xE5: + case 0xE6: + case 0xE7: + case 0xE8: + case 0xE9: + case 0xEA: + case 0xEB: + case 0xEC: + case 0xEE: + case 0xEF: + { + if (JSON_UNLIKELY(not (next_byte_in_range({0x80, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+D000..U+D7FF: bytes ED 80..9F 80..BF + case 0xED: + { + if (JSON_UNLIKELY(not (next_byte_in_range({0x80, 0x9F, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+10000..U+3FFFF F0 90..BF 80..BF 80..BF + case 0xF0: + { + if (JSON_UNLIKELY(not (next_byte_in_range({0x90, 0xBF, 0x80, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF + case 0xF1: + case 0xF2: + case 0xF3: + { + if (JSON_UNLIKELY(not (next_byte_in_range({0x80, 0xBF, 0x80, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // U+100000..U+10FFFF F4 80..8F 80..BF 80..BF + case 0xF4: + { + if (JSON_UNLIKELY(not (next_byte_in_range({0x80, 0x8F, 0x80, 0xBF, 0x80, 0xBF})))) + { + return token_type::parse_error; + } + break; + } + + // remaining bytes (80..C1 and F5..FF) are ill-formed + default: + { + error_message = "invalid string: ill-formed UTF-8 byte"; + return token_type::parse_error; + } + } + } + } + + static void strtof(float& f, const char* str, char** endptr) noexcept + { + f = std::strtof(str, endptr); + } + + static void strtof(double& f, const char* str, char** endptr) noexcept + { + f = std::strtod(str, endptr); + } + + static void strtof(long double& f, const char* str, char** endptr) noexcept + { + f = std::strtold(str, endptr); + } + + /*! + @brief scan a number literal + + This function scans a string according to Sect. 6 of RFC 7159. + + The function is realized with a deterministic finite state machine derived + from the grammar described in RFC 7159. Starting in state "init", the + input is read and used to determined the next state. Only state "done" + accepts the number. State "error" is a trap state to model errors. In the + table below, "anything" means any character but the ones listed before. + + state | 0 | 1-9 | e E | + | - | . | anything + ---------|----------|----------|----------|---------|---------|----------|----------- + init | zero | any1 | [error] | [error] | minus | [error] | [error] + minus | zero | any1 | [error] | [error] | [error] | [error] | [error] + zero | done | done | exponent | done | done | decimal1 | done + any1 | any1 | any1 | exponent | done | done | decimal1 | done + decimal1 | decimal2 | [error] | [error] | [error] | [error] | [error] | [error] + decimal2 | decimal2 | decimal2 | exponent | done | done | done | done + exponent | any2 | any2 | [error] | sign | sign | [error] | [error] + sign | any2 | any2 | [error] | [error] | [error] | [error] | [error] + any2 | any2 | any2 | done | done | done | done | done + + The state machine is realized with one label per state (prefixed with + "scan_number_") and `goto` statements between them. The state machine + contains cycles, but any cycle can be left when EOF is read. Therefore, + the function is guaranteed to terminate. + + During scanning, the read bytes are stored in token_buffer. This string is + then converted to a signed integer, an unsigned integer, or a + floating-point number. + + @return token_type::value_unsigned, token_type::value_integer, or + token_type::value_float if number could be successfully scanned, + token_type::parse_error otherwise + + @note The scanner is independent of the current locale. Internally, the + locale's decimal point is used instead of `.` to work with the + locale-dependent converters. + */ + token_type scan_number() + { + // reset token_buffer to store the number's bytes + reset(); + + // the type of the parsed number; initially set to unsigned; will be + // changed if minus sign, decimal point or exponent is read + token_type number_type = token_type::value_unsigned; + + // state (init): we just found out we need to scan a number + switch (current) + { + case '-': + { + add(current); + goto scan_number_minus; + } + + case '0': + { + add(current); + goto scan_number_zero; + } + + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any1; + } + + default: + { + // all other characters are rejected outside scan_number() + assert(false); // LCOV_EXCL_LINE + } + } + +scan_number_minus: + // state: we just parsed a leading minus sign + number_type = token_type::value_integer; + switch (get()) + { + case '0': + { + add(current); + goto scan_number_zero; + } + + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any1; + } + + default: + { + error_message = "invalid number; expected digit after '-'"; + return token_type::parse_error; + } + } + +scan_number_zero: + // state: we just parse a zero (maybe with a leading minus sign) + switch (get()) + { + case '.': + { + add(decimal_point_char); + goto scan_number_decimal1; + } + + case 'e': + case 'E': + { + add(current); + goto scan_number_exponent; + } + + default: + goto scan_number_done; + } + +scan_number_any1: + // state: we just parsed a number 0-9 (maybe with a leading minus sign) + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any1; + } + + case '.': + { + add(decimal_point_char); + goto scan_number_decimal1; + } + + case 'e': + case 'E': + { + add(current); + goto scan_number_exponent; + } + + default: + goto scan_number_done; + } + +scan_number_decimal1: + // state: we just parsed a decimal point + number_type = token_type::value_float; + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_decimal2; + } + + default: + { + error_message = "invalid number; expected digit after '.'"; + return token_type::parse_error; + } + } + +scan_number_decimal2: + // we just parsed at least one number after a decimal point + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_decimal2; + } + + case 'e': + case 'E': + { + add(current); + goto scan_number_exponent; + } + + default: + goto scan_number_done; + } + +scan_number_exponent: + // we just parsed an exponent + number_type = token_type::value_float; + switch (get()) + { + case '+': + case '-': + { + add(current); + goto scan_number_sign; + } + + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any2; + } + + default: + { + error_message = + "invalid number; expected '+', '-', or digit after exponent"; + return token_type::parse_error; + } + } + +scan_number_sign: + // we just parsed an exponent sign + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any2; + } + + default: + { + error_message = "invalid number; expected digit after exponent sign"; + return token_type::parse_error; + } + } + +scan_number_any2: + // we just parsed a number after the exponent or exponent sign + switch (get()) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + { + add(current); + goto scan_number_any2; + } + + default: + goto scan_number_done; + } + +scan_number_done: + // unget the character after the number (we only read it to know that + // we are done scanning a number) + unget(); + + char* endptr = nullptr; + errno = 0; + + // try to parse integers first and fall back to floats + if (number_type == token_type::value_unsigned) + { + const auto x = std::strtoull(token_buffer.data(), &endptr, 10); + + // we checked the number format before + assert(endptr == token_buffer.data() + token_buffer.size()); + + if (errno == 0) + { + value_unsigned = static_cast<number_unsigned_t>(x); + if (value_unsigned == x) + { + return token_type::value_unsigned; + } + } + } + else if (number_type == token_type::value_integer) + { + const auto x = std::strtoll(token_buffer.data(), &endptr, 10); + + // we checked the number format before + assert(endptr == token_buffer.data() + token_buffer.size()); + + if (errno == 0) + { + value_integer = static_cast<number_integer_t>(x); + if (value_integer == x) + { + return token_type::value_integer; + } + } + } + + // this code is reached if we parse a floating-point number or if an + // integer conversion above failed + strtof(value_float, token_buffer.data(), &endptr); + + // we checked the number format before + assert(endptr == token_buffer.data() + token_buffer.size()); + + return token_type::value_float; + } + + /*! + @param[in] literal_text the literal text to expect + @param[in] length the length of the passed literal text + @param[in] return_type the token type to return on success + */ + token_type scan_literal(const char* literal_text, const std::size_t length, + token_type return_type) + { + assert(current == literal_text[0]); + for (std::size_t i = 1; i < length; ++i) + { + if (JSON_UNLIKELY(get() != literal_text[i])) + { + error_message = "invalid literal"; + return token_type::parse_error; + } + } + return return_type; + } + + ///////////////////// + // input management + ///////////////////// + + /// reset token_buffer; current character is beginning of token + void reset() noexcept + { + token_buffer.clear(); + token_string.clear(); + token_string.push_back(std::char_traits<char>::to_char_type(current)); + } + + /* + @brief get next character from the input + + This function provides the interface to the used input adapter. It does + not throw in case the input reached EOF, but returns a + `std::char_traits<char>::eof()` in that case. Stores the scanned characters + for use in error messages. + + @return character read from the input + */ + std::char_traits<char>::int_type get() + { + ++chars_read; + if (next_unget) + { + // just reset the next_unget variable and work with current + next_unget = false; + } + else + { + current = ia->get_character(); + } + + if (JSON_LIKELY(current != std::char_traits<char>::eof())) + { + token_string.push_back(std::char_traits<char>::to_char_type(current)); + } + return current; + } + + /*! + @brief unget current character (read it again on next get) + + We implement unget by setting variable next_unget to true. The input is not + changed - we just simulate ungetting by modifying chars_read and + token_string. The next call to get() will behave as if the unget character + is read again. + */ + void unget() + { + next_unget = true; + --chars_read; + if (JSON_LIKELY(current != std::char_traits<char>::eof())) + { + assert(token_string.size() != 0); + token_string.pop_back(); + } + } + + /// add a character to token_buffer + void add(int c) + { + token_buffer.push_back(std::char_traits<char>::to_char_type(c)); + } + + public: + ///////////////////// + // value getters + ///////////////////// + + /// return integer value + constexpr number_integer_t get_number_integer() const noexcept + { + return value_integer; + } + + /// return unsigned integer value + constexpr number_unsigned_t get_number_unsigned() const noexcept + { + return value_unsigned; + } + + /// return floating-point value + constexpr number_float_t get_number_float() const noexcept + { + return value_float; + } + + /// return current string value (implicitly resets the token; useful only once) + string_t& get_string() + { + return token_buffer; + } + + ///////////////////// + // diagnostics + ///////////////////// + + /// return position of last read token + constexpr std::size_t get_position() const noexcept + { + return chars_read; + } + + /// return the last read token (for errors only). Will never contain EOF + /// (an arbitrary value that is not a valid char value, often -1), because + /// 255 may legitimately occur. May contain NUL, which should be escaped. + std::string get_token_string() const + { + // escape control characters + std::string result; + for (const auto c : token_string) + { + if ('\x00' <= c and c <= '\x1F') + { + // escape control characters + char cs[9]; + snprintf(cs, 9, "<U+%.4hhX>", static_cast<unsigned char>(c)); + result += cs; + } + else + { + // add character as is + result.push_back(c); + } + } + + return result; + } + + /// return syntax error message + constexpr const char* get_error_message() const noexcept + { + return error_message; + } + + ///////////////////// + // actual scanner + ///////////////////// + + /*! + @brief skip the UTF-8 byte order mark + @return true iff there is no BOM or the correct BOM has been skipped + */ + bool skip_bom() + { + if (get() == 0xEF) + { + if (get() == 0xBB and get() == 0xBF) + { + // we completely parsed the BOM + return true; + } + else + { + // after reading 0xEF, an unexpected character followed + return false; + } + } + else + { + // the first character is not the beginning of the BOM; unget it to + // process is later + unget(); + return true; + } + } + + token_type scan() + { + // initially, skip the BOM + if (chars_read == 0 and not skip_bom()) + { + error_message = "invalid BOM; must be 0xEF 0xBB 0xBF if given"; + return token_type::parse_error; + } + + // read next character and ignore whitespace + do + { + get(); + } + while (current == ' ' or current == '\t' or current == '\n' or current == '\r'); + + switch (current) + { + // structural characters + case '[': + return token_type::begin_array; + case ']': + return token_type::end_array; + case '{': + return token_type::begin_object; + case '}': + return token_type::end_object; + case ':': + return token_type::name_separator; + case ',': + return token_type::value_separator; + + // literals + case 't': + return scan_literal("true", 4, token_type::literal_true); + case 'f': + return scan_literal("false", 5, token_type::literal_false); + case 'n': + return scan_literal("null", 4, token_type::literal_null); + + // string + case '\"': + return scan_string(); + + // number + case '-': + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + return scan_number(); + + // end of input (the null byte is needed when parsing from + // string literals) + case '\0': + case std::char_traits<char>::eof(): + return token_type::end_of_input; + + // error + default: + error_message = "invalid literal"; + return token_type::parse_error; + } + } + + private: + /// input adapter + detail::input_adapter_t ia = nullptr; + + /// the current character + std::char_traits<char>::int_type current = std::char_traits<char>::eof(); + + /// whether the next get() call should just return current + bool next_unget = false; + + /// the number of characters read + std::size_t chars_read = 0; + + /// raw input token string (for error messages) + std::vector<char> token_string {}; + + /// buffer for variable-length tokens (numbers, strings) + string_t token_buffer {}; + + /// a description of occurred lexer errors + const char* error_message = ""; + + // number values + number_integer_t value_integer = 0; + number_unsigned_t value_unsigned = 0; + number_float_t value_float = 0; + + /// the decimal point + const char decimal_point_char = '.'; +}; +} +} + +// #include <nlohmann/detail/input/parser.hpp> + + +#include <cassert> // assert +#include <cmath> // isfinite +#include <cstdint> // uint8_t +#include <functional> // function +#include <string> // string +#include <utility> // move + +// #include <nlohmann/detail/exceptions.hpp> + +// #include <nlohmann/detail/macro_scope.hpp> + +// #include <nlohmann/detail/input/input_adapters.hpp> + +// #include <nlohmann/detail/input/json_sax.hpp> + + +#include <cstddef> +#include <string> +#include <vector> + +// #include <nlohmann/detail/input/parser.hpp> + +// #include <nlohmann/detail/exceptions.hpp> + + +namespace nlohmann +{ + +/*! +@brief SAX interface +*/ +template<typename BasicJsonType> +struct json_sax +{ + /// type for (signed) integers + using number_integer_t = typename BasicJsonType::number_integer_t; + /// type for unsigned integers + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + /// type for floating-point numbers + using number_float_t = typename BasicJsonType::number_float_t; + /// type for strings + using string_t = typename BasicJsonType::string_t; + + /// constant to indicate that no size limit is given for array or object + static constexpr auto no_limit = std::size_t(-1); + + /*! + @brief a null value was read + @return whether parsing should proceed + */ + virtual bool null() = 0; + + /*! + @brief a boolean value was read + @param[in] val boolean value + @return whether parsing should proceed + */ + virtual bool boolean(bool val) = 0; + + /*! + @brief an integer number was read + @param[in] val integer value + @return whether parsing should proceed + */ + virtual bool number_integer(number_integer_t val) = 0; + + /*! + @brief an unsigned integer number was read + @param[in] val unsigned integer value + @return whether parsing should proceed + */ + virtual bool number_unsigned(number_unsigned_t val) = 0; + + /*! + @brief an floating-point number was read + @param[in] val floating-point value + @param[in] s raw token value + @return whether parsing should proceed + */ + virtual bool number_float(number_float_t val, const string_t& s) = 0; + + /*! + @brief a string was read + @param[in] val string value + @return whether parsing should proceed + */ + virtual bool string(string_t& val) = 0; + + /*! + @brief the beginning of an object was read + @param[in] elements number of object elements or no_limit if unknown + @return whether parsing should proceed + @note binary formats may report the number of elements + */ + virtual bool start_object(std::size_t elements = no_limit) = 0; + + /*! + @brief an object key was read + @param[in] val object key + @return whether parsing should proceed + */ + virtual bool key(string_t& val) = 0; + + /*! + @brief the end of an object was read + @return whether parsing should proceed + */ + virtual bool end_object() = 0; + + /*! + @brief the beginning of an array was read + @param[in] elements number of array elements or no_limit if unknown + @return whether parsing should proceed + @note binary formats may report the number of elements + */ + virtual bool start_array(std::size_t elements = no_limit) = 0; + + /*! + @brief the end of an array was read + @return whether parsing should proceed + */ + virtual bool end_array() = 0; + + /*! + @brief a parse error occurred + @param[in] position the position in the input where the error occurs + @param[in] last_token the last read token + @param[in] error_msg a detailed error message + @return whether parsing should proceed (must return false) + */ + virtual bool parse_error(std::size_t position, + const std::string& last_token, + const detail::exception& ex) = 0; + + virtual ~json_sax() = default; +}; + + +namespace detail +{ +/*! +@brief SAX implementation to create a JSON value from SAX events + +This class implements the @ref json_sax interface and processes the SAX events +to create a JSON value which makes it basically a DOM parser. The structure or +hierarchy of the JSON value is managed by the stack `ref_stack` which contains +a pointer to the respective array or object for each recursion depth. + +After successful parsing, the value that is passed by reference to the +constructor contains the parsed value. + +@tparam BasicJsonType the JSON type +*/ +template<typename BasicJsonType> +class json_sax_dom_parser : public json_sax<BasicJsonType> +{ + public: + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + + /*! + @param[in, out] r reference to a JSON value that is manipulated while + parsing + @param[in] allow_exceptions_ whether parse errors yield exceptions + */ + json_sax_dom_parser(BasicJsonType& r, const bool allow_exceptions_ = true) + : root(r), allow_exceptions(allow_exceptions_) + {} + + bool null() override + { + handle_value(nullptr); + return true; + } + + bool boolean(bool val) override + { + handle_value(val); + return true; + } + + bool number_integer(number_integer_t val) override + { + handle_value(val); + return true; + } + + bool number_unsigned(number_unsigned_t val) override + { + handle_value(val); + return true; + } + + bool number_float(number_float_t val, const string_t&) override + { + handle_value(val); + return true; + } + + bool string(string_t& val) override + { + handle_value(val); + return true; + } + + bool start_object(std::size_t len) override + { + ref_stack.push_back(handle_value(BasicJsonType::value_t::object)); + + if (JSON_UNLIKELY(len != json_sax<BasicJsonType>::no_limit and len > ref_stack.back()->max_size())) + { + JSON_THROW(out_of_range::create(408, + "excessive object size: " + std::to_string(len))); + } + + return true; + } + + bool key(string_t& val) override + { + // add null at given key and store the reference for later + object_element = &(ref_stack.back()->m_value.object->operator[](val)); + return true; + } + + bool end_object() override + { + ref_stack.pop_back(); + return true; + } + + bool start_array(std::size_t len) override + { + ref_stack.push_back(handle_value(BasicJsonType::value_t::array)); + + if (JSON_UNLIKELY(len != json_sax<BasicJsonType>::no_limit and len > ref_stack.back()->max_size())) + { + JSON_THROW(out_of_range::create(408, + "excessive array size: " + std::to_string(len))); + } + + return true; + } + + bool end_array() override + { + ref_stack.pop_back(); + return true; + } + + bool parse_error(std::size_t, const std::string&, + const detail::exception& ex) override + { + errored = true; + if (allow_exceptions) + { + // determine the proper exception type from the id + switch ((ex.id / 100) % 100) + { + case 1: + JSON_THROW(*reinterpret_cast<const detail::parse_error*>(&ex)); + case 2: + JSON_THROW(*reinterpret_cast<const detail::invalid_iterator*>(&ex)); // LCOV_EXCL_LINE + case 3: + JSON_THROW(*reinterpret_cast<const detail::type_error*>(&ex)); // LCOV_EXCL_LINE + case 4: + JSON_THROW(*reinterpret_cast<const detail::out_of_range*>(&ex)); + case 5: + JSON_THROW(*reinterpret_cast<const detail::other_error*>(&ex)); // LCOV_EXCL_LINE + default: + assert(false); // LCOV_EXCL_LINE + } + } + return false; + } + + constexpr bool is_errored() const + { + return errored; + } + + private: + /*! + @invariant If the ref stack is empty, then the passed value will be the new + root. + @invariant If the ref stack contains a value, then it is an array or an + object to which we can add elements + */ + template<typename Value> + BasicJsonType* handle_value(Value&& v) + { + if (ref_stack.empty()) + { + root = BasicJsonType(std::forward<Value>(v)); + return &root; + } + else + { + assert(ref_stack.back()->is_array() or ref_stack.back()->is_object()); + if (ref_stack.back()->is_array()) + { + ref_stack.back()->m_value.array->emplace_back(std::forward<Value>(v)); + return &(ref_stack.back()->m_value.array->back()); + } + else + { + assert(object_element); + *object_element = BasicJsonType(std::forward<Value>(v)); + return object_element; + } + } + } + + /// the parsed JSON value + BasicJsonType& root; + /// stack to model hierarchy of values + std::vector<BasicJsonType*> ref_stack; + /// helper to hold the reference for the next object element + BasicJsonType* object_element = nullptr; + /// whether a syntax error occurred + bool errored = false; + /// whether to throw exceptions in case of errors + const bool allow_exceptions = true; +}; + +template<typename BasicJsonType> +class json_sax_dom_callback_parser : public json_sax<BasicJsonType> +{ + public: + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using parser_callback_t = typename BasicJsonType::parser_callback_t; + using parse_event_t = typename BasicJsonType::parse_event_t; + + json_sax_dom_callback_parser(BasicJsonType& r, + const parser_callback_t cb, + const bool allow_exceptions_ = true) + : root(r), callback(cb), allow_exceptions(allow_exceptions_) + { + keep_stack.push_back(true); + } + + bool null() override + { + handle_value(nullptr); + return true; + } + + bool boolean(bool val) override + { + handle_value(val); + return true; + } + + bool number_integer(number_integer_t val) override + { + handle_value(val); + return true; + } + + bool number_unsigned(number_unsigned_t val) override + { + handle_value(val); + return true; + } + + bool number_float(number_float_t val, const string_t&) override + { + handle_value(val); + return true; + } + + bool string(string_t& val) override + { + handle_value(val); + return true; + } + + bool start_object(std::size_t len) override + { + // check callback for object start + const bool keep = callback(static_cast<int>(ref_stack.size()), parse_event_t::object_start, discarded); + keep_stack.push_back(keep); + + auto val = handle_value(BasicJsonType::value_t::object, true); + ref_stack.push_back(val.second); + + // check object limit + if (ref_stack.back()) + { + if (JSON_UNLIKELY(len != json_sax<BasicJsonType>::no_limit and len > ref_stack.back()->max_size())) + { + JSON_THROW(out_of_range::create(408, + "excessive object size: " + std::to_string(len))); + } + } + + return true; + } + + bool key(string_t& val) override + { + BasicJsonType k = BasicJsonType(val); + + // check callback for key + const bool keep = callback(static_cast<int>(ref_stack.size()), parse_event_t::key, k); + key_keep_stack.push_back(keep); + + // add discarded value at given key and store the reference for later + if (keep and ref_stack.back()) + { + object_element = &(ref_stack.back()->m_value.object->operator[](val) = discarded); + } + + return true; + } + + bool end_object() override + { + if (ref_stack.back()) + { + if (not callback(static_cast<int>(ref_stack.size()) - 1, parse_event_t::object_end, *ref_stack.back())) + { + // discard object + *ref_stack.back() = discarded; + } + } + + assert(not ref_stack.empty()); + assert(not keep_stack.empty()); + ref_stack.pop_back(); + keep_stack.pop_back(); + + if (not ref_stack.empty() and ref_stack.back()) + { + // remove discarded value + if (ref_stack.back()->is_object()) + { + for (auto it = ref_stack.back()->begin(); it != ref_stack.back()->end(); ++it) + { + if (it->is_discarded()) + { + ref_stack.back()->erase(it); + break; + } + } + } + } + + return true; + } + + bool start_array(std::size_t len) override + { + const bool keep = callback(static_cast<int>(ref_stack.size()), parse_event_t::array_start, discarded); + keep_stack.push_back(keep); + + auto val = handle_value(BasicJsonType::value_t::array, true); + ref_stack.push_back(val.second); + + // check array limit + if (ref_stack.back()) + { + if (JSON_UNLIKELY(len != json_sax<BasicJsonType>::no_limit and len > ref_stack.back()->max_size())) + { + JSON_THROW(out_of_range::create(408, + "excessive array size: " + std::to_string(len))); + } + } + + return true; + } + + bool end_array() override + { + bool keep = true; + + if (ref_stack.back()) + { + keep = callback(static_cast<int>(ref_stack.size()) - 1, parse_event_t::array_end, *ref_stack.back()); + if (not keep) + { + // discard array + *ref_stack.back() = discarded; + } + } + + assert(not ref_stack.empty()); + assert(not keep_stack.empty()); + ref_stack.pop_back(); + keep_stack.pop_back(); + + // remove discarded value + if (not keep and not ref_stack.empty()) + { + if (ref_stack.back()->is_array()) + { + ref_stack.back()->m_value.array->pop_back(); + } + } + + return true; + } + + bool parse_error(std::size_t, const std::string&, + const detail::exception& ex) override + { + errored = true; + if (allow_exceptions) + { + // determine the proper exception type from the id + switch ((ex.id / 100) % 100) + { + case 1: + JSON_THROW(*reinterpret_cast<const detail::parse_error*>(&ex)); + case 2: + JSON_THROW(*reinterpret_cast<const detail::invalid_iterator*>(&ex)); // LCOV_EXCL_LINE + case 3: + JSON_THROW(*reinterpret_cast<const detail::type_error*>(&ex)); // LCOV_EXCL_LINE + case 4: + JSON_THROW(*reinterpret_cast<const detail::out_of_range*>(&ex)); + case 5: + JSON_THROW(*reinterpret_cast<const detail::other_error*>(&ex)); // LCOV_EXCL_LINE + default: + assert(false); // LCOV_EXCL_LINE + } + } + return false; + } + + constexpr bool is_errored() const + { + return errored; + } + + private: + /*! + @param[in] v value to add to the JSON value we build during parsing + @param[in] skip_callback whether we should skip calling the callback + function; this is required after start_array() and + start_object() SAX events, because otherwise we would call the + callback function with an empty array or object, respectively. + + @invariant If the ref stack is empty, then the passed value will be the new + root. + @invariant If the ref stack contains a value, then it is an array or an + object to which we can add elements + + @return pair of boolean (whether value should be kept) and pointer (to the + passed value in the ref_stack hierarchy; nullptr if not kept) + */ + template<typename Value> + std::pair<bool, BasicJsonType*> handle_value(Value&& v, const bool skip_callback = false) + { + assert(not keep_stack.empty()); + + // do not handle this value if we know it would be added to a discarded + // container + if (not keep_stack.back()) + { + return {false, nullptr}; + } + + // create value + auto value = BasicJsonType(std::forward<Value>(v)); + + // check callback + const bool keep = skip_callback or callback(static_cast<int>(ref_stack.size()), parse_event_t::value, value); + + // do not handle this value if we just learnt it shall be discarded + if (not keep) + { + return {false, nullptr}; + } + + if (ref_stack.empty()) + { + root = std::move(value); + return {true, &root}; + } + else + { + assert(ref_stack.back()->is_array() or ref_stack.back()->is_object()); + if (ref_stack.back()->is_array()) + { + ref_stack.back()->m_value.array->push_back(std::move(value)); + return {true, &(ref_stack.back()->m_value.array->back())}; + } + else + { + // check if we should store an element for the current key + assert(not key_keep_stack.empty()); + const bool store_element = key_keep_stack.back(); + key_keep_stack.pop_back(); + + if (not store_element) + { + return {false, nullptr}; + } + + assert(object_element); + *object_element = std::move(value); + return {true, object_element}; + } + } + } + + /// the parsed JSON value + BasicJsonType& root; + /// stack to model hierarchy of values + std::vector<BasicJsonType*> ref_stack; + /// stack to manage which values to keep + std::vector<bool> keep_stack; + /// stack to manage which object keys to keep + std::vector<bool> key_keep_stack; + /// helper to hold the reference for the next object element + BasicJsonType* object_element = nullptr; + /// whether a syntax error occurred + bool errored = false; + /// callback function + const parser_callback_t callback = nullptr; + /// whether to throw exceptions in case of errors + const bool allow_exceptions = true; + /// a discarded value for the callback + BasicJsonType discarded = BasicJsonType::value_t::discarded; +}; + +template<typename BasicJsonType> +class json_sax_acceptor : public json_sax<BasicJsonType> +{ + public: + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + + bool null() override + { + return true; + } + + bool boolean(bool) override + { + return true; + } + + bool number_integer(number_integer_t) override + { + return true; + } + + bool number_unsigned(number_unsigned_t) override + { + return true; + } + + bool number_float(number_float_t, const string_t&) override + { + return true; + } + + bool string(string_t&) override + { + return true; + } + + bool start_object(std::size_t) override + { + return true; + } + + bool key(string_t&) override + { + return true; + } + + bool end_object() override + { + return true; + } + + bool start_array(std::size_t) override + { + return true; + } + + bool end_array() override + { + return true; + } + + bool parse_error(std::size_t, const std::string&, const detail::exception&) override + { + return false; + } +}; +} + +} + +// #include <nlohmann/detail/input/lexer.hpp> + +// #include <nlohmann/detail/value_t.hpp> + + +namespace nlohmann +{ +namespace detail +{ +//////////// +// parser // +//////////// + +/*! +@brief syntax analysis + +This class implements a recursive decent parser. +*/ +template<typename BasicJsonType> +class parser +{ + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using lexer_t = lexer<BasicJsonType>; + using token_type = typename lexer_t::token_type; + + public: + enum class parse_event_t : uint8_t + { + /// the parser read `{` and started to process a JSON object + object_start, + /// the parser read `}` and finished processing a JSON object + object_end, + /// the parser read `[` and started to process a JSON array + array_start, + /// the parser read `]` and finished processing a JSON array + array_end, + /// the parser read a key of a value in an object + key, + /// the parser finished reading a JSON value + value + }; + + using json_sax_t = json_sax<BasicJsonType>; + + using parser_callback_t = + std::function<bool(int depth, parse_event_t event, BasicJsonType& parsed)>; + + /// a parser reading from an input adapter + explicit parser(detail::input_adapter_t&& adapter, + const parser_callback_t cb = nullptr, + const bool allow_exceptions_ = true) + : callback(cb), m_lexer(std::move(adapter)), allow_exceptions(allow_exceptions_) + { + // read first token + get_token(); + } + + /*! + @brief public parser interface + + @param[in] strict whether to expect the last token to be EOF + @param[in,out] result parsed JSON value + + @throw parse_error.101 in case of an unexpected token + @throw parse_error.102 if to_unicode fails or surrogate error + @throw parse_error.103 if to_unicode fails + */ + void parse(const bool strict, BasicJsonType& result) + { + if (callback) + { + json_sax_dom_callback_parser<BasicJsonType> sdp(result, callback, allow_exceptions); + sax_parse_internal(&sdp); + result.assert_invariant(); + + // in strict mode, input must be completely read + if (strict and (get_token() != token_type::end_of_input)) + { + sdp.parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::end_of_input))); + } + + // in case of an error, return discarded value + if (sdp.is_errored()) + { + result = value_t::discarded; + return; + } + + // set top-level value to null if it was discarded by the callback + // function + if (result.is_discarded()) + { + result = nullptr; + } + } + else + { + json_sax_dom_parser<BasicJsonType> sdp(result, allow_exceptions); + sax_parse_internal(&sdp); + result.assert_invariant(); + + // in strict mode, input must be completely read + if (strict and (get_token() != token_type::end_of_input)) + { + sdp.parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::end_of_input))); + } + + // in case of an error, return discarded value + if (sdp.is_errored()) + { + result = value_t::discarded; + return; + } + } + } + + /*! + @brief public accept interface + + @param[in] strict whether to expect the last token to be EOF + @return whether the input is a proper JSON text + */ + bool accept(const bool strict = true) + { + json_sax_acceptor<BasicJsonType> sax_acceptor; + return sax_parse(&sax_acceptor, strict); + } + + bool sax_parse(json_sax_t* sax, const bool strict = true) + { + const bool result = sax_parse_internal(sax); + + // strict mode: next byte must be EOF + if (result and strict and (get_token() != token_type::end_of_input)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::end_of_input))); + } + + return result; + } + + private: + bool sax_parse_internal(json_sax_t* sax) + { + // stack to remember the hieararchy of structured values we are parsing + // true = array; false = object + std::vector<bool> states; + // value to avoid a goto (see comment where set to true) + bool skip_to_state_evaluation = false; + + while (true) + { + if (not skip_to_state_evaluation) + { + // invariant: get_token() was called before each iteration + switch (last_token) + { + case token_type::begin_object: + { + if (JSON_UNLIKELY(not sax->start_object())) + { + return false; + } + + // closing } -> we are done + if (get_token() == token_type::end_object) + { + if (JSON_UNLIKELY(not sax->end_object())) + { + return false; + } + break; + } + + // parse key + if (JSON_UNLIKELY(last_token != token_type::value_string)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::value_string))); + } + else + { + if (JSON_UNLIKELY(not sax->key(m_lexer.get_string()))) + { + return false; + } + } + + // parse separator (:) + if (JSON_UNLIKELY(get_token() != token_type::name_separator)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::name_separator))); + } + + // remember we are now inside an object + states.push_back(false); + + // parse values + get_token(); + continue; + } + + case token_type::begin_array: + { + if (JSON_UNLIKELY(not sax->start_array())) + { + return false; + } + + // closing ] -> we are done + if (get_token() == token_type::end_array) + { + if (JSON_UNLIKELY(not sax->end_array())) + { + return false; + } + break; + } + + // remember we are now inside an array + states.push_back(true); + + // parse values (no need to call get_token) + continue; + } + + case token_type::value_float: + { + const auto res = m_lexer.get_number_float(); + + if (JSON_UNLIKELY(not std::isfinite(res))) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + out_of_range::create(406, "number overflow parsing '" + m_lexer.get_token_string() + "'")); + } + else + { + if (JSON_UNLIKELY(not sax->number_float(res, m_lexer.get_string()))) + { + return false; + } + break; + } + } + + case token_type::literal_false: + { + if (JSON_UNLIKELY(not sax->boolean(false))) + { + return false; + } + break; + } + + case token_type::literal_null: + { + if (JSON_UNLIKELY(not sax->null())) + { + return false; + } + break; + } + + case token_type::literal_true: + { + if (JSON_UNLIKELY(not sax->boolean(true))) + { + return false; + } + break; + } + + case token_type::value_integer: + { + if (JSON_UNLIKELY(not sax->number_integer(m_lexer.get_number_integer()))) + { + return false; + } + break; + } + + case token_type::value_string: + { + if (JSON_UNLIKELY(not sax->string(m_lexer.get_string()))) + { + return false; + } + break; + } + + case token_type::value_unsigned: + { + if (JSON_UNLIKELY(not sax->number_unsigned(m_lexer.get_number_unsigned()))) + { + return false; + } + break; + } + + case token_type::parse_error: + { + // using "uninitialized" to avoid "expected" message + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::uninitialized))); + } + + default: // the last token was unexpected + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::literal_or_value))); + } + } + } + else + { + skip_to_state_evaluation = false; + } + + // we reached this line after we successfully parsed a value + if (states.empty()) + { + // empty stack: we reached the end of the hieararchy: done + return true; + } + else + { + if (states.back()) // array + { + // comma -> next value + if (get_token() == token_type::value_separator) + { + // parse a new value + get_token(); + continue; + } + + // closing ] + if (JSON_LIKELY(last_token == token_type::end_array)) + { + if (JSON_UNLIKELY(not sax->end_array())) + { + return false; + } + + // We are done with this array. Before we can parse a + // new value, we need to evaluate the new state first. + // By setting skip_to_state_evaluation to false, we + // are effectively jumping to the beginning of this if. + assert(not states.empty()); + states.pop_back(); + skip_to_state_evaluation = true; + continue; + } + else + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::end_array))); + } + } + else // object + { + // comma -> next value + if (get_token() == token_type::value_separator) + { + // parse key + if (JSON_UNLIKELY(get_token() != token_type::value_string)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::value_string))); + } + else + { + if (JSON_UNLIKELY(not sax->key(m_lexer.get_string()))) + { + return false; + } + } + + // parse separator (:) + if (JSON_UNLIKELY(get_token() != token_type::name_separator)) + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::name_separator))); + } + + // parse values + get_token(); + continue; + } + + // closing } + if (JSON_LIKELY(last_token == token_type::end_object)) + { + if (JSON_UNLIKELY(not sax->end_object())) + { + return false; + } + + // We are done with this object. Before we can parse a + // new value, we need to evaluate the new state first. + // By setting skip_to_state_evaluation to false, we + // are effectively jumping to the beginning of this if. + assert(not states.empty()); + states.pop_back(); + skip_to_state_evaluation = true; + continue; + } + else + { + return sax->parse_error(m_lexer.get_position(), + m_lexer.get_token_string(), + parse_error::create(101, m_lexer.get_position(), exception_message(token_type::end_object))); + } + } + } + } + } + + /// get next token from lexer + token_type get_token() + { + return (last_token = m_lexer.scan()); + } + + std::string exception_message(const token_type expected) + { + std::string error_msg = "syntax error - "; + if (last_token == token_type::parse_error) + { + error_msg += std::string(m_lexer.get_error_message()) + "; last read: '" + + m_lexer.get_token_string() + "'"; + } + else + { + error_msg += "unexpected " + std::string(lexer_t::token_type_name(last_token)); + } + + if (expected != token_type::uninitialized) + { + error_msg += "; expected " + std::string(lexer_t::token_type_name(expected)); + } + + return error_msg; + } + + private: + /// callback function + const parser_callback_t callback = nullptr; + /// the type of the last read token + token_type last_token = token_type::uninitialized; + /// the lexer + lexer_t m_lexer; + /// whether to throw exceptions in case of errors + const bool allow_exceptions = true; +}; +} +} + +// #include <nlohmann/detail/iterators/primitive_iterator.hpp> + + +#include <cstddef> // ptrdiff_t +#include <limits> // numeric_limits + +namespace nlohmann +{ +namespace detail +{ +/* +@brief an iterator for primitive JSON types + +This class models an iterator for primitive JSON types (boolean, number, +string). It's only purpose is to allow the iterator/const_iterator classes +to "iterate" over primitive values. Internally, the iterator is modeled by +a `difference_type` variable. Value begin_value (`0`) models the begin, +end_value (`1`) models past the end. +*/ +class primitive_iterator_t +{ + private: + using difference_type = std::ptrdiff_t; + static constexpr difference_type begin_value = 0; + static constexpr difference_type end_value = begin_value + 1; + + /// iterator as signed integer type + difference_type m_it = (std::numeric_limits<std::ptrdiff_t>::min)(); + + public: + constexpr difference_type get_value() const noexcept + { + return m_it; + } + + /// set iterator to a defined beginning + void set_begin() noexcept + { + m_it = begin_value; + } + + /// set iterator to a defined past the end + void set_end() noexcept + { + m_it = end_value; + } + + /// return whether the iterator can be dereferenced + constexpr bool is_begin() const noexcept + { + return m_it == begin_value; + } + + /// return whether the iterator is at end + constexpr bool is_end() const noexcept + { + return m_it == end_value; + } + + friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept + { + return lhs.m_it == rhs.m_it; + } + + friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept + { + return lhs.m_it < rhs.m_it; + } + + primitive_iterator_t operator+(difference_type n) noexcept + { + auto result = *this; + result += n; + return result; + } + + friend constexpr difference_type operator-(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept + { + return lhs.m_it - rhs.m_it; + } + + primitive_iterator_t& operator++() noexcept + { + ++m_it; + return *this; + } + + primitive_iterator_t const operator++(int) noexcept + { + auto result = *this; + ++m_it; + return result; + } + + primitive_iterator_t& operator--() noexcept + { + --m_it; + return *this; + } + + primitive_iterator_t const operator--(int) noexcept + { + auto result = *this; + --m_it; + return result; + } + + primitive_iterator_t& operator+=(difference_type n) noexcept + { + m_it += n; + return *this; + } + + primitive_iterator_t& operator-=(difference_type n) noexcept + { + m_it -= n; + return *this; + } +}; +} +} + +// #include <nlohmann/detail/iterators/internal_iterator.hpp> + + +// #include <nlohmann/detail/iterators/primitive_iterator.hpp> + + +namespace nlohmann +{ +namespace detail +{ +/*! +@brief an iterator value + +@note This structure could easily be a union, but MSVC currently does not allow +unions members with complex constructors, see https://github.com/nlohmann/json/pull/105. +*/ +template<typename BasicJsonType> struct internal_iterator +{ + /// iterator for JSON objects + typename BasicJsonType::object_t::iterator object_iterator {}; + /// iterator for JSON arrays + typename BasicJsonType::array_t::iterator array_iterator {}; + /// generic iterator for all other types + primitive_iterator_t primitive_iterator {}; +}; +} +} + +// #include <nlohmann/detail/iterators/iter_impl.hpp> + + +#include <ciso646> // not +#include <iterator> // iterator, random_access_iterator_tag, bidirectional_iterator_tag, advance, next +#include <type_traits> // conditional, is_const, remove_const + +// #include <nlohmann/detail/exceptions.hpp> + +// #include <nlohmann/detail/iterators/internal_iterator.hpp> + +// #include <nlohmann/detail/iterators/primitive_iterator.hpp> + +// #include <nlohmann/detail/macro_scope.hpp> + +// #include <nlohmann/detail/meta.hpp> + +// #include <nlohmann/detail/value_t.hpp> + + +namespace nlohmann +{ +namespace detail +{ +// forward declare, to be able to friend it later on +template<typename IteratorType> class iteration_proxy; + +/*! +@brief a template for a bidirectional iterator for the @ref basic_json class + +This class implements a both iterators (iterator and const_iterator) for the +@ref basic_json class. + +@note An iterator is called *initialized* when a pointer to a JSON value has + been set (e.g., by a constructor or a copy assignment). If the iterator is + default-constructed, it is *uninitialized* and most methods are undefined. + **The library uses assertions to detect calls on uninitialized iterators.** + +@requirement The class satisfies the following concept requirements: +- +[BidirectionalIterator](https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator): + The iterator that can be moved can be moved in both directions (i.e. + incremented and decremented). + +@since version 1.0.0, simplified in version 2.0.9, change to bidirectional + iterators in version 3.0.0 (see https://github.com/nlohmann/json/issues/593) +*/ +template<typename BasicJsonType> +class iter_impl +{ + /// allow basic_json to access private members + friend iter_impl<typename std::conditional<std::is_const<BasicJsonType>::value, typename std::remove_const<BasicJsonType>::type, const BasicJsonType>::type>; + friend BasicJsonType; + friend iteration_proxy<iter_impl>; + + using object_t = typename BasicJsonType::object_t; + using array_t = typename BasicJsonType::array_t; + // make sure BasicJsonType is basic_json or const basic_json + static_assert(is_basic_json<typename std::remove_const<BasicJsonType>::type>::value, + "iter_impl only accepts (const) basic_json"); + + public: + + /// The std::iterator class template (used as a base class to provide typedefs) is deprecated in C++17. + /// The C++ Standard has never required user-defined iterators to derive from std::iterator. + /// A user-defined iterator should provide publicly accessible typedefs named + /// iterator_category, value_type, difference_type, pointer, and reference. + /// Note that value_type is required to be non-const, even for constant iterators. + using iterator_category = std::bidirectional_iterator_tag; + + /// the type of the values when the iterator is dereferenced + using value_type = typename BasicJsonType::value_type; + /// a type to represent differences between iterators + using difference_type = typename BasicJsonType::difference_type; + /// defines a pointer to the type iterated over (value_type) + using pointer = typename std::conditional<std::is_const<BasicJsonType>::value, + typename BasicJsonType::const_pointer, + typename BasicJsonType::pointer>::type; + /// defines a reference to the type iterated over (value_type) + using reference = + typename std::conditional<std::is_const<BasicJsonType>::value, + typename BasicJsonType::const_reference, + typename BasicJsonType::reference>::type; + + /// default constructor + iter_impl() = default; + + /*! + @brief constructor for a given JSON instance + @param[in] object pointer to a JSON object for this iterator + @pre object != nullptr + @post The iterator is initialized; i.e. `m_object != nullptr`. + */ + explicit iter_impl(pointer object) noexcept : m_object(object) + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + m_it.object_iterator = typename object_t::iterator(); + break; + } + + case value_t::array: + { + m_it.array_iterator = typename array_t::iterator(); + break; + } + + default: + { + m_it.primitive_iterator = primitive_iterator_t(); + break; + } + } + } + + /*! + @note The conventional copy constructor and copy assignment are implicitly + defined. Combined with the following converting constructor and + assignment, they support: (1) copy from iterator to iterator, (2) + copy from const iterator to const iterator, and (3) conversion from + iterator to const iterator. However conversion from const iterator + to iterator is not defined. + */ + + /*! + @brief converting constructor + @param[in] other non-const iterator to copy from + @note It is not checked whether @a other is initialized. + */ + iter_impl(const iter_impl<typename std::remove_const<BasicJsonType>::type>& other) noexcept + : m_object(other.m_object), m_it(other.m_it) {} + + /*! + @brief converting assignment + @param[in,out] other non-const iterator to copy from + @return const/non-const iterator + @note It is not checked whether @a other is initialized. + */ + iter_impl& operator=(const iter_impl<typename std::remove_const<BasicJsonType>::type>& other) noexcept + { + m_object = other.m_object; + m_it = other.m_it; + return *this; + } + + private: + /*! + @brief set the iterator to the first value + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + void set_begin() noexcept + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + m_it.object_iterator = m_object->m_value.object->begin(); + break; + } + + case value_t::array: + { + m_it.array_iterator = m_object->m_value.array->begin(); + break; + } + + case value_t::null: + { + // set to end so begin()==end() is true: null is empty + m_it.primitive_iterator.set_end(); + break; + } + + default: + { + m_it.primitive_iterator.set_begin(); + break; + } + } + } + + /*! + @brief set the iterator past the last value + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + void set_end() noexcept + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + m_it.object_iterator = m_object->m_value.object->end(); + break; + } + + case value_t::array: + { + m_it.array_iterator = m_object->m_value.array->end(); + break; + } + + default: + { + m_it.primitive_iterator.set_end(); + break; + } + } + } + + public: + /*! + @brief return a reference to the value pointed to by the iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + reference operator*() const + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + assert(m_it.object_iterator != m_object->m_value.object->end()); + return m_it.object_iterator->second; + } + + case value_t::array: + { + assert(m_it.array_iterator != m_object->m_value.array->end()); + return *m_it.array_iterator; + } + + case value_t::null: + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + + default: + { + if (JSON_LIKELY(m_it.primitive_iterator.is_begin())) + { + return *m_object; + } + + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + } + } + } + + /*! + @brief dereference the iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + pointer operator->() const + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + assert(m_it.object_iterator != m_object->m_value.object->end()); + return &(m_it.object_iterator->second); + } + + case value_t::array: + { + assert(m_it.array_iterator != m_object->m_value.array->end()); + return &*m_it.array_iterator; + } + + default: + { + if (JSON_LIKELY(m_it.primitive_iterator.is_begin())) + { + return m_object; + } + + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + } + } + } + + /*! + @brief post-increment (it++) + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl const operator++(int) + { + auto result = *this; + ++(*this); + return result; + } + + /*! + @brief pre-increment (++it) + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl& operator++() + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + std::advance(m_it.object_iterator, 1); + break; + } + + case value_t::array: + { + std::advance(m_it.array_iterator, 1); + break; + } + + default: + { + ++m_it.primitive_iterator; + break; + } + } + + return *this; + } + + /*! + @brief post-decrement (it--) + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl const operator--(int) + { + auto result = *this; + --(*this); + return result; + } + + /*! + @brief pre-decrement (--it) + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl& operator--() + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + { + std::advance(m_it.object_iterator, -1); + break; + } + + case value_t::array: + { + std::advance(m_it.array_iterator, -1); + break; + } + + default: + { + --m_it.primitive_iterator; + break; + } + } + + return *this; + } + + /*! + @brief comparison: equal + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator==(const iter_impl& other) const + { + // if objects are not the same, the comparison is undefined + if (JSON_UNLIKELY(m_object != other.m_object)) + { + JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers")); + } + + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + return (m_it.object_iterator == other.m_it.object_iterator); + + case value_t::array: + return (m_it.array_iterator == other.m_it.array_iterator); + + default: + return (m_it.primitive_iterator == other.m_it.primitive_iterator); + } + } + + /*! + @brief comparison: not equal + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator!=(const iter_impl& other) const + { + return not operator==(other); + } + + /*! + @brief comparison: smaller + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator<(const iter_impl& other) const + { + // if objects are not the same, the comparison is undefined + if (JSON_UNLIKELY(m_object != other.m_object)) + { + JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers")); + } + + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + JSON_THROW(invalid_iterator::create(213, "cannot compare order of object iterators")); + + case value_t::array: + return (m_it.array_iterator < other.m_it.array_iterator); + + default: + return (m_it.primitive_iterator < other.m_it.primitive_iterator); + } + } + + /*! + @brief comparison: less than or equal + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator<=(const iter_impl& other) const + { + return not other.operator < (*this); + } + + /*! + @brief comparison: greater than + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator>(const iter_impl& other) const + { + return not operator<=(other); + } + + /*! + @brief comparison: greater than or equal + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + bool operator>=(const iter_impl& other) const + { + return not operator<(other); + } + + /*! + @brief add to iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl& operator+=(difference_type i) + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators")); + + case value_t::array: + { + std::advance(m_it.array_iterator, i); + break; + } + + default: + { + m_it.primitive_iterator += i; + break; + } + } + + return *this; + } + + /*! + @brief subtract from iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl& operator-=(difference_type i) + { + return operator+=(-i); + } + + /*! + @brief add to iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl operator+(difference_type i) const + { + auto result = *this; + result += i; + return result; + } + + /*! + @brief addition of distance and iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + friend iter_impl operator+(difference_type i, const iter_impl& it) + { + auto result = it; + result += i; + return result; + } + + /*! + @brief subtract from iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + iter_impl operator-(difference_type i) const + { + auto result = *this; + result -= i; + return result; + } + + /*! + @brief return difference + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + difference_type operator-(const iter_impl& other) const + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators")); + + case value_t::array: + return m_it.array_iterator - other.m_it.array_iterator; + + default: + return m_it.primitive_iterator - other.m_it.primitive_iterator; + } + } + + /*! + @brief access to successor + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + reference operator[](difference_type n) const + { + assert(m_object != nullptr); + + switch (m_object->m_type) + { + case value_t::object: + JSON_THROW(invalid_iterator::create(208, "cannot use operator[] for object iterators")); + + case value_t::array: + return *std::next(m_it.array_iterator, n); + + case value_t::null: + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + + default: + { + if (JSON_LIKELY(m_it.primitive_iterator.get_value() == -n)) + { + return *m_object; + } + + JSON_THROW(invalid_iterator::create(214, "cannot get value")); + } + } + } + + /*! + @brief return the key of an object iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + const typename object_t::key_type& key() const + { + assert(m_object != nullptr); + + if (JSON_LIKELY(m_object->is_object())) + { + return m_it.object_iterator->first; + } + + JSON_THROW(invalid_iterator::create(207, "cannot use key() for non-object iterators")); + } + + /*! + @brief return the value of an iterator + @pre The iterator is initialized; i.e. `m_object != nullptr`. + */ + reference value() const + { + return operator*(); + } + + private: + /// associated JSON instance + pointer m_object = nullptr; + /// the actual iterator of the associated instance + internal_iterator<typename std::remove_const<BasicJsonType>::type> m_it; +}; +} +} + +// #include <nlohmann/detail/iterators/iteration_proxy.hpp> + +// #include <nlohmann/detail/iterators/json_reverse_iterator.hpp> + + +#include <cstddef> // ptrdiff_t +#include <iterator> // reverse_iterator +#include <utility> // declval + +namespace nlohmann +{ +namespace detail +{ +////////////////////// +// reverse_iterator // +////////////////////// + +/*! +@brief a template for a reverse iterator class + +@tparam Base the base iterator type to reverse. Valid types are @ref +iterator (to create @ref reverse_iterator) and @ref const_iterator (to +create @ref const_reverse_iterator). + +@requirement The class satisfies the following concept requirements: +- +[BidirectionalIterator](https://en.cppreference.com/w/cpp/named_req/BidirectionalIterator): + The iterator that can be moved can be moved in both directions (i.e. + incremented and decremented). +- [OutputIterator](https://en.cppreference.com/w/cpp/named_req/OutputIterator): + It is possible to write to the pointed-to element (only if @a Base is + @ref iterator). + +@since version 1.0.0 +*/ +template<typename Base> +class json_reverse_iterator : public std::reverse_iterator<Base> +{ + public: + using difference_type = std::ptrdiff_t; + /// shortcut to the reverse iterator adapter + using base_iterator = std::reverse_iterator<Base>; + /// the reference type for the pointed-to element + using reference = typename Base::reference; + + /// create reverse iterator from iterator + explicit json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept + : base_iterator(it) {} + + /// create reverse iterator from base class + explicit json_reverse_iterator(const base_iterator& it) noexcept : base_iterator(it) {} + + /// post-increment (it++) + json_reverse_iterator const operator++(int) + { + return static_cast<json_reverse_iterator>(base_iterator::operator++(1)); + } + + /// pre-increment (++it) + json_reverse_iterator& operator++() + { + return static_cast<json_reverse_iterator&>(base_iterator::operator++()); + } + + /// post-decrement (it--) + json_reverse_iterator const operator--(int) + { + return static_cast<json_reverse_iterator>(base_iterator::operator--(1)); + } + + /// pre-decrement (--it) + json_reverse_iterator& operator--() + { + return static_cast<json_reverse_iterator&>(base_iterator::operator--()); + } + + /// add to iterator + json_reverse_iterator& operator+=(difference_type i) + { + return static_cast<json_reverse_iterator&>(base_iterator::operator+=(i)); + } + + /// add to iterator + json_reverse_iterator operator+(difference_type i) const + { + return static_cast<json_reverse_iterator>(base_iterator::operator+(i)); + } + + /// subtract from iterator + json_reverse_iterator operator-(difference_type i) const + { + return static_cast<json_reverse_iterator>(base_iterator::operator-(i)); + } + + /// return difference + difference_type operator-(const json_reverse_iterator& other) const + { + return base_iterator(*this) - base_iterator(other); + } + + /// access to successor + reference operator[](difference_type n) const + { + return *(this->operator+(n)); + } + + /// return the key of an object iterator + auto key() const -> decltype(std::declval<Base>().key()) + { + auto it = --this->base(); + return it.key(); + } + + /// return the value of an iterator + reference value() const + { + auto it = --this->base(); + return it.operator * (); + } +}; +} +} + +// #include <nlohmann/detail/output/output_adapters.hpp> + + +#include <algorithm> // copy +#include <cstddef> // size_t +#include <ios> // streamsize +#include <iterator> // back_inserter +#include <memory> // shared_ptr, make_shared +#include <ostream> // basic_ostream +#include <string> // basic_string +#include <vector> // vector + +namespace nlohmann +{ +namespace detail +{ +/// abstract output adapter interface +template<typename CharType> struct output_adapter_protocol +{ + virtual void write_character(CharType c) = 0; + virtual void write_characters(const CharType* s, std::size_t length) = 0; + virtual ~output_adapter_protocol() = default; +}; + +/// a type to simplify interfaces +template<typename CharType> +using output_adapter_t = std::shared_ptr<output_adapter_protocol<CharType>>; + +/// output adapter for byte vectors +template<typename CharType> +class output_vector_adapter : public output_adapter_protocol<CharType> +{ + public: + explicit output_vector_adapter(std::vector<CharType>& vec) : v(vec) {} + + void write_character(CharType c) override + { + v.push_back(c); + } + + void write_characters(const CharType* s, std::size_t length) override + { + std::copy(s, s + length, std::back_inserter(v)); + } + + private: + std::vector<CharType>& v; +}; + +/// output adapter for output streams +template<typename CharType> +class output_stream_adapter : public output_adapter_protocol<CharType> +{ + public: + explicit output_stream_adapter(std::basic_ostream<CharType>& s) : stream(s) {} + + void write_character(CharType c) override + { + stream.put(c); + } + + void write_characters(const CharType* s, std::size_t length) override + { + stream.write(s, static_cast<std::streamsize>(length)); + } + + private: + std::basic_ostream<CharType>& stream; +}; + +/// output adapter for basic_string +template<typename CharType, typename StringType = std::basic_string<CharType>> +class output_string_adapter : public output_adapter_protocol<CharType> +{ + public: + explicit output_string_adapter(StringType& s) : str(s) {} + + void write_character(CharType c) override + { + str.push_back(c); + } + + void write_characters(const CharType* s, std::size_t length) override + { + str.append(s, length); + } + + private: + StringType& str; +}; + +template<typename CharType, typename StringType = std::basic_string<CharType>> +class output_adapter +{ + public: + output_adapter(std::vector<CharType>& vec) + : oa(std::make_shared<output_vector_adapter<CharType>>(vec)) {} + + output_adapter(std::basic_ostream<CharType>& s) + : oa(std::make_shared<output_stream_adapter<CharType>>(s)) {} + + output_adapter(StringType& s) + : oa(std::make_shared<output_string_adapter<CharType, StringType>>(s)) {} + + operator output_adapter_t<CharType>() + { + return oa; + } + + private: + output_adapter_t<CharType> oa = nullptr; +}; +} +} + +// #include <nlohmann/detail/input/binary_reader.hpp> + + +#include <algorithm> // generate_n +#include <array> // array +#include <cassert> // assert +#include <cmath> // ldexp +#include <cstddef> // size_t +#include <cstdint> // uint8_t, uint16_t, uint32_t, uint64_t +#include <cstdio> // snprintf +#include <cstring> // memcpy +#include <iterator> // back_inserter +#include <limits> // numeric_limits +#include <string> // char_traits, string +#include <utility> // make_pair, move + +// #include <nlohmann/detail/input/input_adapters.hpp> + +// #include <nlohmann/detail/input/json_sax.hpp> + +// #include <nlohmann/detail/exceptions.hpp> + +// #include <nlohmann/detail/macro_scope.hpp> + +// #include <nlohmann/detail/value_t.hpp> + + +namespace nlohmann +{ +namespace detail +{ +/////////////////// +// binary reader // +/////////////////// + +/*! +@brief deserialization of CBOR, MessagePack, and UBJSON values +*/ +template<typename BasicJsonType> +class binary_reader +{ + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using number_float_t = typename BasicJsonType::number_float_t; + using string_t = typename BasicJsonType::string_t; + using json_sax_t = json_sax<BasicJsonType>; + + public: + /*! + @brief create a binary reader + + @param[in] adapter input adapter to read from + */ + explicit binary_reader(input_adapter_t adapter) : ia(std::move(adapter)) + { + assert(ia); + } + + /*! + @param[in] format the binary format to parse + @param[in] sax_ a SAX event processor + @param[in] strict whether to expect the input to be consumed completed + + @return + */ + bool sax_parse(const input_format_t format, + json_sax_t* sax_, + const bool strict = true) + { + sax = sax_; + bool result; + + switch (format) + { + case input_format_t::cbor: + result = parse_cbor_internal(); + break; + + case input_format_t::msgpack: + result = parse_msgpack_internal(); + break; + + case input_format_t::ubjson: + result = parse_ubjson_internal(); + break; + + default: + assert(false); // LCOV_EXCL_LINE + } + + // strict mode: next byte must be EOF + if (result and strict) + { + if (format == input_format_t::ubjson) + { + get_ignore_noop(); + } + else + { + get(); + } + + if (JSON_UNLIKELY(current != std::char_traits<char>::eof())) + { + return sax->parse_error(chars_read, get_token_string(), parse_error::create(110, chars_read, "expected end of input")); + } + } + + return result; + } + + /*! + @brief determine system byte order + + @return true if and only if system's byte order is little endian + + @note from http://stackoverflow.com/a/1001328/266378 + */ + static constexpr bool little_endianess(int num = 1) noexcept + { + return (*reinterpret_cast<char*>(&num) == 1); + } + + private: + /*! + @param[in] get_char whether a new character should be retrieved from the + input (true, default) or whether the last read + character should be considered instead + + @return whether a valid CBOR value was passed to the SAX parser + */ + bool parse_cbor_internal(const bool get_char = true) + { + switch (get_char ? get() : current) + { + // EOF + case std::char_traits<char>::eof(): + return unexpect_eof(); + + // Integer 0x00..0x17 (0..23) + case 0x00: + case 0x01: + case 0x02: + case 0x03: + case 0x04: + case 0x05: + case 0x06: + case 0x07: + case 0x08: + case 0x09: + case 0x0A: + case 0x0B: + case 0x0C: + case 0x0D: + case 0x0E: + case 0x0F: + case 0x10: + case 0x11: + case 0x12: + case 0x13: + case 0x14: + case 0x15: + case 0x16: + case 0x17: + return sax->number_unsigned(static_cast<number_unsigned_t>(current)); + + case 0x18: // Unsigned integer (one-byte uint8_t follows) + { + uint8_t number; + return get_number(number) and sax->number_unsigned(number); + } + + case 0x19: // Unsigned integer (two-byte uint16_t follows) + { + uint16_t number; + return get_number(number) and sax->number_unsigned(number); + } + + case 0x1A: // Unsigned integer (four-byte uint32_t follows) + { + uint32_t number; + return get_number(number) and sax->number_unsigned(number); + } + + case 0x1B: // Unsigned integer (eight-byte uint64_t follows) + { + uint64_t number; + return get_number(number) and sax->number_unsigned(number); + } + + // Negative integer -1-0x00..-1-0x17 (-1..-24) + case 0x20: + case 0x21: + case 0x22: + case 0x23: + case 0x24: + case 0x25: + case 0x26: + case 0x27: + case 0x28: + case 0x29: + case 0x2A: + case 0x2B: + case 0x2C: + case 0x2D: + case 0x2E: + case 0x2F: + case 0x30: + case 0x31: + case 0x32: + case 0x33: + case 0x34: + case 0x35: + case 0x36: + case 0x37: + return sax->number_integer(static_cast<int8_t>(0x20 - 1 - current)); + + case 0x38: // Negative integer (one-byte uint8_t follows) + { + uint8_t number; + return get_number(number) and sax->number_integer(static_cast<number_integer_t>(-1) - number); + } + + case 0x39: // Negative integer -1-n (two-byte uint16_t follows) + { + uint16_t number; + return get_number(number) and sax->number_integer(static_cast<number_integer_t>(-1) - number); + } + + case 0x3A: // Negative integer -1-n (four-byte uint32_t follows) + { + uint32_t number; + return get_number(number) and sax->number_integer(static_cast<number_integer_t>(-1) - number); + } + + case 0x3B: // Negative integer -1-n (eight-byte uint64_t follows) + { + uint64_t number; + return get_number(number) and sax->number_integer(static_cast<number_integer_t>(-1) + - static_cast<number_integer_t>(number)); + } + + // UTF-8 string (0x00..0x17 bytes follow) + case 0x60: + case 0x61: + case 0x62: + case 0x63: + case 0x64: + case 0x65: + case 0x66: + case 0x67: + case 0x68: + case 0x69: + case 0x6A: + case 0x6B: + case 0x6C: + case 0x6D: + case 0x6E: + case 0x6F: + case 0x70: + case 0x71: + case 0x72: + case 0x73: + case 0x74: + case 0x75: + case 0x76: + case 0x77: + case 0x78: // UTF-8 string (one-byte uint8_t for n follows) + case 0x79: // UTF-8 string (two-byte uint16_t for n follow) + case 0x7A: // UTF-8 string (four-byte uint32_t for n follow) + case 0x7B: // UTF-8 string (eight-byte uint64_t for n follow) + case 0x7F: // UTF-8 string (indefinite length) + { + string_t s; + return get_cbor_string(s) and sax->string(s); + } + + // array (0x00..0x17 data items follow) + case 0x80: + case 0x81: + case 0x82: + case 0x83: + case 0x84: + case 0x85: + case 0x86: + case 0x87: + case 0x88: + case 0x89: + case 0x8A: + case 0x8B: + case 0x8C: + case 0x8D: + case 0x8E: + case 0x8F: + case 0x90: + case 0x91: + case 0x92: + case 0x93: + case 0x94: + case 0x95: + case 0x96: + case 0x97: + return get_cbor_array(static_cast<std::size_t>(current & 0x1F)); + + case 0x98: // array (one-byte uint8_t for n follows) + { + uint8_t len; + return get_number(len) and get_cbor_array(static_cast<std::size_t>(len)); + } + + case 0x99: // array (two-byte uint16_t for n follow) + { + uint16_t len; + return get_number(len) and get_cbor_array(static_cast<std::size_t>(len)); + } + + case 0x9A: // array (four-byte uint32_t for n follow) + { + uint32_t len; + return get_number(len) and get_cbor_array(static_cast<std::size_t>(len)); + } + + case 0x9B: // array (eight-byte uint64_t for n follow) + { + uint64_t len; + return get_number(len) and get_cbor_array(static_cast<std::size_t>(len)); + } + + case 0x9F: // array (indefinite length) + return get_cbor_array(json_sax_t::no_limit); + + // map (0x00..0x17 pairs of data items follow) + case 0xA0: + case 0xA1: + case 0xA2: + case 0xA3: + case 0xA4: + case 0xA5: + case 0xA6: + case 0xA7: + case 0xA8: + case 0xA9: + case 0xAA: + case 0xAB: + case 0xAC: + case 0xAD: + case 0xAE: + case 0xAF: + case 0xB0: + case 0xB1: + case 0xB2: + case 0xB3: + case 0xB4: + case 0xB5: + case 0xB6: + case 0xB7: + return get_cbor_object(static_cast<std::size_t>(current & 0x1F)); + + case 0xB8: // map (one-byte uint8_t for n follows) + { + uint8_t len; + return get_number(len) and get_cbor_object(static_cast<std::size_t>(len)); + } + + case 0xB9: // map (two-byte uint16_t for n follow) + { + uint16_t len; + return get_number(len) and get_cbor_object(static_cast<std::size_t>(len)); + } + + case 0xBA: // map (four-byte uint32_t for n follow) + { + uint32_t len; + return get_number(len) and get_cbor_object(static_cast<std::size_t>(len)); + } + + case 0xBB: // map (eight-byte uint64_t for n follow) + { + uint64_t len; + return get_number(len) and get_cbor_object(static_cast<std::size_t>(len)); + } + + case 0xBF: // map (indefinite length) + return get_cbor_object(json_sax_t::no_limit); + + case 0xF4: // false + return sax->boolean(false); + + case 0xF5: // true + return sax->boolean(true); + + case 0xF6: // null + return sax->null(); + + case 0xF9: // Half-Precision Float (two-byte IEEE 754) + { + const int byte1 = get(); + if (JSON_UNLIKELY(not unexpect_eof())) + { + return false; + } + const int byte2 = get(); + if (JSON_UNLIKELY(not unexpect_eof())) + { + return false; + } + + // code from RFC 7049, Appendix D, Figure 3: + // As half-precision floating-point numbers were only added + // to IEEE 754 in 2008, today's programming platforms often + // still only have limited support for them. It is very + // easy to include at least decoding support for them even + // without such support. An example of a small decoder for + // half-precision floating-point numbers in the C language + // is shown in Fig. 3. + const int half = (byte1 << 8) + byte2; + const double val = [&half] + { + const int exp = (half >> 10) & 0x1F; + const int mant = half & 0x3FF; + assert(0 <= exp and exp <= 32); + assert(0 <= mant and mant <= 1024); + switch (exp) + { + case 0: + return std::ldexp(mant, -24); + case 31: + return (mant == 0) + ? std::numeric_limits<double>::infinity() + : std::numeric_limits<double>::quiet_NaN(); + default: + return std::ldexp(mant + 1024, exp - 25); + } + }(); + return sax->number_float((half & 0x8000) != 0 + ? static_cast<number_float_t>(-val) + : static_cast<number_float_t>(val), ""); + } + + case 0xFA: // Single-Precision Float (four-byte IEEE 754) + { + float number; + return get_number(number) and sax->number_float(static_cast<number_float_t>(number), ""); + } + + case 0xFB: // Double-Precision Float (eight-byte IEEE 754) + { + double number; + return get_number(number) and sax->number_float(static_cast<number_float_t>(number), ""); + } + + default: // anything else (0xFF is handled inside the other types) + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, "error reading CBOR; last byte: 0x" + last_token)); + } + } + } + + /*! + @return whether a valid MessagePack value was passed to the SAX parser + */ + bool parse_msgpack_internal() + { + switch (get()) + { + // EOF + case std::char_traits<char>::eof(): + return unexpect_eof(); + + // positive fixint + case 0x00: + case 0x01: + case 0x02: + case 0x03: + case 0x04: + case 0x05: + case 0x06: + case 0x07: + case 0x08: + case 0x09: + case 0x0A: + case 0x0B: + case 0x0C: + case 0x0D: + case 0x0E: + case 0x0F: + case 0x10: + case 0x11: + case 0x12: + case 0x13: + case 0x14: + case 0x15: + case 0x16: + case 0x17: + case 0x18: + case 0x19: + case 0x1A: + case 0x1B: + case 0x1C: + case 0x1D: + case 0x1E: + case 0x1F: + case 0x20: + case 0x21: + case 0x22: + case 0x23: + case 0x24: + case 0x25: + case 0x26: + case 0x27: + case 0x28: + case 0x29: + case 0x2A: + case 0x2B: + case 0x2C: + case 0x2D: + case 0x2E: + case 0x2F: + case 0x30: + case 0x31: + case 0x32: + case 0x33: + case 0x34: + case 0x35: + case 0x36: + case 0x37: + case 0x38: + case 0x39: + case 0x3A: + case 0x3B: + case 0x3C: + case 0x3D: + case 0x3E: + case 0x3F: + case 0x40: + case 0x41: + case 0x42: + case 0x43: + case 0x44: + case 0x45: + case 0x46: + case 0x47: + case 0x48: + case 0x49: + case 0x4A: + case 0x4B: + case 0x4C: + case 0x4D: + case 0x4E: + case 0x4F: + case 0x50: + case 0x51: + case 0x52: + case 0x53: + case 0x54: + case 0x55: + case 0x56: + case 0x57: + case 0x58: + case 0x59: + case 0x5A: + case 0x5B: + case 0x5C: + case 0x5D: + case 0x5E: + case 0x5F: + case 0x60: + case 0x61: + case 0x62: + case 0x63: + case 0x64: + case 0x65: + case 0x66: + case 0x67: + case 0x68: + case 0x69: + case 0x6A: + case 0x6B: + case 0x6C: + case 0x6D: + case 0x6E: + case 0x6F: + case 0x70: + case 0x71: + case 0x72: + case 0x73: + case 0x74: + case 0x75: + case 0x76: + case 0x77: + case 0x78: + case 0x79: + case 0x7A: + case 0x7B: + case 0x7C: + case 0x7D: + case 0x7E: + case 0x7F: + return sax->number_unsigned(static_cast<number_unsigned_t>(current)); + + // fixmap + case 0x80: + case 0x81: + case 0x82: + case 0x83: + case 0x84: + case 0x85: + case 0x86: + case 0x87: + case 0x88: + case 0x89: + case 0x8A: + case 0x8B: + case 0x8C: + case 0x8D: + case 0x8E: + case 0x8F: + return get_msgpack_object(static_cast<std::size_t>(current & 0x0F)); + + // fixarray + case 0x90: + case 0x91: + case 0x92: + case 0x93: + case 0x94: + case 0x95: + case 0x96: + case 0x97: + case 0x98: + case 0x99: + case 0x9A: + case 0x9B: + case 0x9C: + case 0x9D: + case 0x9E: + case 0x9F: + return get_msgpack_array(static_cast<std::size_t>(current & 0x0F)); + + // fixstr + case 0xA0: + case 0xA1: + case 0xA2: + case 0xA3: + case 0xA4: + case 0xA5: + case 0xA6: + case 0xA7: + case 0xA8: + case 0xA9: + case 0xAA: + case 0xAB: + case 0xAC: + case 0xAD: + case 0xAE: + case 0xAF: + case 0xB0: + case 0xB1: + case 0xB2: + case 0xB3: + case 0xB4: + case 0xB5: + case 0xB6: + case 0xB7: + case 0xB8: + case 0xB9: + case 0xBA: + case 0xBB: + case 0xBC: + case 0xBD: + case 0xBE: + case 0xBF: + { + string_t s; + return get_msgpack_string(s) and sax->string(s); + } + + case 0xC0: // nil + return sax->null(); + + case 0xC2: // false + return sax->boolean(false); + + case 0xC3: // true + return sax->boolean(true); + + case 0xCA: // float 32 + { + float number; + return get_number(number) and sax->number_float(static_cast<number_float_t>(number), ""); + } + + case 0xCB: // float 64 + { + double number; + return get_number(number) and sax->number_float(static_cast<number_float_t>(number), ""); + } + + case 0xCC: // uint 8 + { + uint8_t number; + return get_number(number) and sax->number_unsigned(number); + } + + case 0xCD: // uint 16 + { + uint16_t number; + return get_number(number) and sax->number_unsigned(number); + } + + case 0xCE: // uint 32 + { + uint32_t number; + return get_number(number) and sax->number_unsigned(number); + } + + case 0xCF: // uint 64 + { + uint64_t number; + return get_number(number) and sax->number_unsigned(number); + } + + case 0xD0: // int 8 + { + int8_t number; + return get_number(number) and sax->number_integer(number); + } + + case 0xD1: // int 16 + { + int16_t number; + return get_number(number) and sax->number_integer(number); + } + + case 0xD2: // int 32 + { + int32_t number; + return get_number(number) and sax->number_integer(number); + } + + case 0xD3: // int 64 + { + int64_t number; + return get_number(number) and sax->number_integer(number); + } + + case 0xD9: // str 8 + case 0xDA: // str 16 + case 0xDB: // str 32 + { + string_t s; + return get_msgpack_string(s) and sax->string(s); + } + + case 0xDC: // array 16 + { + uint16_t len; + return get_number(len) and get_msgpack_array(static_cast<std::size_t>(len)); + } + + case 0xDD: // array 32 + { + uint32_t len; + return get_number(len) and get_msgpack_array(static_cast<std::size_t>(len)); + } + + case 0xDE: // map 16 + { + uint16_t len; + return get_number(len) and get_msgpack_object(static_cast<std::size_t>(len)); + } + + case 0xDF: // map 32 + { + uint32_t len; + return get_number(len) and get_msgpack_object(static_cast<std::size_t>(len)); + } + + // negative fixint + case 0xE0: + case 0xE1: + case 0xE2: + case 0xE3: + case 0xE4: + case 0xE5: + case 0xE6: + case 0xE7: + case 0xE8: + case 0xE9: + case 0xEA: + case 0xEB: + case 0xEC: + case 0xED: + case 0xEE: + case 0xEF: + case 0xF0: + case 0xF1: + case 0xF2: + case 0xF3: + case 0xF4: + case 0xF5: + case 0xF6: + case 0xF7: + case 0xF8: + case 0xF9: + case 0xFA: + case 0xFB: + case 0xFC: + case 0xFD: + case 0xFE: + case 0xFF: + return sax->number_integer(static_cast<int8_t>(current)); + + default: // anything else + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, "error reading MessagePack; last byte: 0x" + last_token)); + } + } + } + + /*! + @param[in] get_char whether a new character should be retrieved from the + input (true, default) or whether the last read + character should be considered instead + + @return whether a valid UBJSON value was passed to the SAX parser + */ + bool parse_ubjson_internal(const bool get_char = true) + { + return get_ubjson_value(get_char ? get_ignore_noop() : current); + } + + /*! + @brief get next character from the input + + This function provides the interface to the used input adapter. It does + not throw in case the input reached EOF, but returns a -'ve valued + `std::char_traits<char>::eof()` in that case. + + @return character read from the input + */ + int get() + { + ++chars_read; + return (current = ia->get_character()); + } + + /*! + @return character read from the input after ignoring all 'N' entries + */ + int get_ignore_noop() + { + do + { + get(); + } + while (current == 'N'); + + return current; + } + + /* + @brief read a number from the input + + @tparam NumberType the type of the number + @param[out] result number of type @a NumberType + + @return whether conversion completed + + @note This function needs to respect the system's endianess, because + bytes in CBOR, MessagePack, and UBJSON are stored in network order + (big endian) and therefore need reordering on little endian systems. + */ + template<typename NumberType> + bool get_number(NumberType& result) + { + // step 1: read input into array with system's byte order + std::array<uint8_t, sizeof(NumberType)> vec; + for (std::size_t i = 0; i < sizeof(NumberType); ++i) + { + get(); + if (JSON_UNLIKELY(not unexpect_eof())) + { + return false; + } + + // reverse byte order prior to conversion if necessary + if (is_little_endian) + { + vec[sizeof(NumberType) - i - 1] = static_cast<uint8_t>(current); + } + else + { + vec[i] = static_cast<uint8_t>(current); // LCOV_EXCL_LINE + } + } + + // step 2: convert array into number of type T and return + std::memcpy(&result, vec.data(), sizeof(NumberType)); + return true; + } + + /*! + @brief create a string by reading characters from the input + + @tparam NumberType the type of the number + @param[in] len number of characters to read + @param[out] string created by reading @a len bytes + + @return whether string creation completed + + @note We can not reserve @a len bytes for the result, because @a len + may be too large. Usually, @ref unexpect_eof() detects the end of + the input before we run out of string memory. + */ + template<typename NumberType> + bool get_string(const NumberType len, string_t& result) + { + bool success = true; + std::generate_n(std::back_inserter(result), len, [this, &success]() + { + get(); + if (JSON_UNLIKELY(not unexpect_eof())) + { + success = false; + } + return static_cast<char>(current); + }); + return success; + } + + /*! + @brief reads a CBOR string + + This function first reads starting bytes to determine the expected + string length and then copies this number of bytes into a string. + Additionally, CBOR's strings with indefinite lengths are supported. + + @param[out] result created string + + @return whether string creation completed + */ + bool get_cbor_string(string_t& result) + { + if (JSON_UNLIKELY(not unexpect_eof())) + { + return false; + } + + switch (current) + { + // UTF-8 string (0x00..0x17 bytes follow) + case 0x60: + case 0x61: + case 0x62: + case 0x63: + case 0x64: + case 0x65: + case 0x66: + case 0x67: + case 0x68: + case 0x69: + case 0x6A: + case 0x6B: + case 0x6C: + case 0x6D: + case 0x6E: + case 0x6F: + case 0x70: + case 0x71: + case 0x72: + case 0x73: + case 0x74: + case 0x75: + case 0x76: + case 0x77: + { + return get_string(current & 0x1F, result); + } + + case 0x78: // UTF-8 string (one-byte uint8_t for n follows) + { + uint8_t len; + return get_number(len) and get_string(len, result); + } + + case 0x79: // UTF-8 string (two-byte uint16_t for n follow) + { + uint16_t len; + return get_number(len) and get_string(len, result); + } + + case 0x7A: // UTF-8 string (four-byte uint32_t for n follow) + { + uint32_t len; + return get_number(len) and get_string(len, result); + } + + case 0x7B: // UTF-8 string (eight-byte uint64_t for n follow) + { + uint64_t len; + return get_number(len) and get_string(len, result); + } + + case 0x7F: // UTF-8 string (indefinite length) + { + while (get() != 0xFF) + { + string_t chunk; + if (not get_cbor_string(chunk)) + { + return false; + } + result.append(chunk); + } + return true; + } + + default: + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, "expected a CBOR string; last byte: 0x" + last_token)); + } + } + } + + /*! + @param[in] len the length of the array or json_sax_t::no_limit for an + array of indefinite size + @return whether array creation completed + */ + bool get_cbor_array(const std::size_t len) + { + if (JSON_UNLIKELY(not sax->start_array(len))) + { + return false; + } + + if (len != json_sax_t::no_limit) + for (std::size_t i = 0; i < len; ++i) + { + if (JSON_UNLIKELY(not parse_cbor_internal())) + { + return false; + } + } + else + { + while (get() != 0xFF) + { + if (JSON_UNLIKELY(not parse_cbor_internal(false))) + { + return false; + } + } + } + + return sax->end_array(); + } + + /*! + @param[in] len the length of the object or json_sax_t::no_limit for an + object of indefinite size + @return whether object creation completed + */ + bool get_cbor_object(const std::size_t len) + { + if (not JSON_UNLIKELY(sax->start_object(len))) + { + return false; + } + + string_t key; + if (len != json_sax_t::no_limit) + { + for (std::size_t i = 0; i < len; ++i) + { + get(); + if (JSON_UNLIKELY(not get_cbor_string(key) or not sax->key(key))) + { + return false; + } + + if (JSON_UNLIKELY(not parse_cbor_internal())) + { + return false; + } + key.clear(); + } + } + else + { + while (get() != 0xFF) + { + if (JSON_UNLIKELY(not get_cbor_string(key) or not sax->key(key))) + { + return false; + } + + if (JSON_UNLIKELY(not parse_cbor_internal())) + { + return false; + } + key.clear(); + } + } + + return sax->end_object(); + } + + /*! + @brief reads a MessagePack string + + This function first reads starting bytes to determine the expected + string length and then copies this number of bytes into a string. + + @param[out] result created string + + @return whether string creation completed + */ + bool get_msgpack_string(string_t& result) + { + if (JSON_UNLIKELY(not unexpect_eof())) + { + return false; + } + + switch (current) + { + // fixstr + case 0xA0: + case 0xA1: + case 0xA2: + case 0xA3: + case 0xA4: + case 0xA5: + case 0xA6: + case 0xA7: + case 0xA8: + case 0xA9: + case 0xAA: + case 0xAB: + case 0xAC: + case 0xAD: + case 0xAE: + case 0xAF: + case 0xB0: + case 0xB1: + case 0xB2: + case 0xB3: + case 0xB4: + case 0xB5: + case 0xB6: + case 0xB7: + case 0xB8: + case 0xB9: + case 0xBA: + case 0xBB: + case 0xBC: + case 0xBD: + case 0xBE: + case 0xBF: + { + return get_string(current & 0x1F, result); + } + + case 0xD9: // str 8 + { + uint8_t len; + return get_number(len) and get_string(len, result); + } + + case 0xDA: // str 16 + { + uint16_t len; + return get_number(len) and get_string(len, result); + } + + case 0xDB: // str 32 + { + uint32_t len; + return get_number(len) and get_string(len, result); + } + + default: + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, "expected a MessagePack string; last byte: 0x" + last_token)); + } + } + } + + /*! + @param[in] len the length of the array + @return whether array creation completed + */ + bool get_msgpack_array(const std::size_t len) + { + if (JSON_UNLIKELY(not sax->start_array(len))) + { + return false; + } + + for (std::size_t i = 0; i < len; ++i) + { + if (JSON_UNLIKELY(not parse_msgpack_internal())) + { + return false; + } + } + + return sax->end_array(); + } + + /*! + @param[in] len the length of the object + @return whether object creation completed + */ + bool get_msgpack_object(const std::size_t len) + { + if (JSON_UNLIKELY(not sax->start_object(len))) + { + return false; + } + + string_t key; + for (std::size_t i = 0; i < len; ++i) + { + get(); + if (JSON_UNLIKELY(not get_msgpack_string(key) or not sax->key(key))) + { + return false; + } + + if (JSON_UNLIKELY(not parse_msgpack_internal())) + { + return false; + } + key.clear(); + } + + return sax->end_object(); + } + + /*! + @brief reads a UBJSON string + + This function is either called after reading the 'S' byte explicitly + indicating a string, or in case of an object key where the 'S' byte can be + left out. + + @param[out] result created string + @param[in] get_char whether a new character should be retrieved from the + input (true, default) or whether the last read + character should be considered instead + + @return whether string creation completed + */ + bool get_ubjson_string(string_t& result, const bool get_char = true) + { + if (get_char) + { + get(); // TODO: may we ignore N here? + } + + if (JSON_UNLIKELY(not unexpect_eof())) + { + return false; + } + + switch (current) + { + case 'U': + { + uint8_t len; + return get_number(len) and get_string(len, result); + } + + case 'i': + { + int8_t len; + return get_number(len) and get_string(len, result); + } + + case 'I': + { + int16_t len; + return get_number(len) and get_string(len, result); + } + + case 'l': + { + int32_t len; + return get_number(len) and get_string(len, result); + } + + case 'L': + { + int64_t len; + return get_number(len) and get_string(len, result); + } + + default: + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, "expected a UBJSON string; last byte: 0x" + last_token)); + } + } + + /*! + @param[out] result determined size + @return whether size determination completed + */ + bool get_ubjson_size_value(std::size_t& result) + { + switch (get_ignore_noop()) + { + case 'U': + { + uint8_t number; + if (JSON_UNLIKELY(not get_number(number))) + { + return false; + } + result = static_cast<std::size_t>(number); + return true; + } + + case 'i': + { + int8_t number; + if (JSON_UNLIKELY(not get_number(number))) + { + return false; + } + result = static_cast<std::size_t>(number); + return true; + } + + case 'I': + { + int16_t number; + if (JSON_UNLIKELY(not get_number(number))) + { + return false; + } + result = static_cast<std::size_t>(number); + return true; + } + + case 'l': + { + int32_t number; + if (JSON_UNLIKELY(not get_number(number))) + { + return false; + } + result = static_cast<std::size_t>(number); + return true; + } + + case 'L': + { + int64_t number; + if (JSON_UNLIKELY(not get_number(number))) + { + return false; + } + result = static_cast<std::size_t>(number); + return true; + } + + default: + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, "byte after '#' must denote a number type; last byte: 0x" + last_token)); + } + } + } + + /*! + @brief determine the type and size for a container + + In the optimized UBJSON format, a type and a size can be provided to allow + for a more compact representation. + + @param[out] result pair of the size and the type + + @return whether pair creation completed + */ + bool get_ubjson_size_type(std::pair<std::size_t, int>& result) + { + result.first = string_t::npos; // size + result.second = 0; // type + + get_ignore_noop(); + + if (current == '$') + { + result.second = get(); // must not ignore 'N', because 'N' maybe the type + if (JSON_UNLIKELY(not unexpect_eof())) + { + return false; + } + + get_ignore_noop(); + if (JSON_UNLIKELY(current != '#')) + { + if (JSON_UNLIKELY(not unexpect_eof())) + { + return false; + } + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, "expected '#' after UBJSON type information; last byte: 0x" + last_token)); + } + + return get_ubjson_size_value(result.first); + } + else if (current == '#') + { + return get_ubjson_size_value(result.first); + } + return true; + } + + /*! + @param prefix the previously read or set type prefix + @return whether value creation completed + */ + bool get_ubjson_value(const int prefix) + { + switch (prefix) + { + case std::char_traits<char>::eof(): // EOF + return unexpect_eof(); + + case 'T': // true + return sax->boolean(true); + case 'F': // false + return sax->boolean(false); + + case 'Z': // null + return sax->null(); + + case 'U': + { + uint8_t number; + return get_number(number) and sax->number_unsigned(number); + } + + case 'i': + { + int8_t number; + return get_number(number) and sax->number_integer(number); + } + + case 'I': + { + int16_t number; + return get_number(number) and sax->number_integer(number); + } + + case 'l': + { + int32_t number; + return get_number(number) and sax->number_integer(number); + } + + case 'L': + { + int64_t number; + return get_number(number) and sax->number_integer(number); + } + + case 'd': + { + float number; + return get_number(number) and sax->number_float(static_cast<number_float_t>(number), ""); + } + + case 'D': + { + double number; + return get_number(number) and sax->number_float(static_cast<number_float_t>(number), ""); + } + + case 'C': // char + { + get(); + if (JSON_UNLIKELY(not unexpect_eof())) + { + return false; + } + if (JSON_UNLIKELY(current > 127)) + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read, "byte after 'C' must be in range 0x00..0x7F; last byte: 0x" + last_token)); + } + string_t s(1, static_cast<char>(current)); + return sax->string(s); + } + + case 'S': // string + { + string_t s; + return get_ubjson_string(s) and sax->string(s); + } + + case '[': // array + return get_ubjson_array(); + + case '{': // object + return get_ubjson_object(); + + default: // anything else + { + auto last_token = get_token_string(); + return sax->parse_error(chars_read, last_token, parse_error::create(112, chars_read, "error reading UBJSON; last byte: 0x" + last_token)); + } + } + } + + /*! + @return whether array creation completed + */ + bool get_ubjson_array() + { + std::pair<std::size_t, int> size_and_type; + if (JSON_UNLIKELY(not get_ubjson_size_type(size_and_type))) + { + return false; + } + + if (size_and_type.first != string_t::npos) + { + if (JSON_UNLIKELY(not sax->start_array(size_and_type.first))) + { + return false; + } + + if (size_and_type.second != 0) + { + if (size_and_type.second != 'N') + { + for (std::size_t i = 0; i < size_and_type.first; ++i) + { + if (JSON_UNLIKELY(not get_ubjson_value(size_and_type.second))) + { + return false; + } + } + } + } + else + { + for (std::size_t i = 0; i < size_and_type.first; ++i) + { + if (JSON_UNLIKELY(not parse_ubjson_internal())) + { + return false; + } + } + } + } + else + { + if (JSON_UNLIKELY(not sax->start_array())) + { + return false; + } + + while (current != ']') + { + if (JSON_UNLIKELY(not parse_ubjson_internal(false))) + { + return false; + } + get_ignore_noop(); + } + } + + return sax->end_array(); + } + + /*! + @return whether object creation completed + */ + bool get_ubjson_object() + { + std::pair<std::size_t, int> size_and_type; + if (JSON_UNLIKELY(not get_ubjson_size_type(size_and_type))) + { + return false; + } + + string_t key; + if (size_and_type.first != string_t::npos) + { + if (JSON_UNLIKELY(not sax->start_object(size_and_type.first))) + { + return false; + } + + if (size_and_type.second != 0) + { + for (std::size_t i = 0; i < size_and_type.first; ++i) + { + if (JSON_UNLIKELY(not get_ubjson_string(key) or not sax->key(key))) + { + return false; + } + if (JSON_UNLIKELY(not get_ubjson_value(size_and_type.second))) + { + return false; + } + key.clear(); + } + } + else + { + for (std::size_t i = 0; i < size_and_type.first; ++i) + { + if (JSON_UNLIKELY(not get_ubjson_string(key) or not sax->key(key))) + { + return false; + } + if (JSON_UNLIKELY(not parse_ubjson_internal())) + { + return false; + } + key.clear(); + } + } + } + else + { + if (JSON_UNLIKELY(not sax->start_object())) + { + return false; + } + + while (current != '}') + { + if (JSON_UNLIKELY(not get_ubjson_string(key, false) or not sax->key(key))) + { + return false; + } + if (JSON_UNLIKELY(not parse_ubjson_internal())) + { + return false; + } + get_ignore_noop(); + key.clear(); + } + } + + return sax->end_object(); + } + + /*! + @return whether the last read character is not EOF + */ + bool unexpect_eof() const + { + if (JSON_UNLIKELY(current == std::char_traits<char>::eof())) + { + return sax->parse_error(chars_read, "<end of file>", parse_error::create(110, chars_read, "unexpected end of input")); + } + return true; + } + + /*! + @return a string representation of the last read byte + */ + std::string get_token_string() const + { + char cr[3]; + snprintf(cr, 3, "%.2hhX", static_cast<unsigned char>(current)); + return std::string{cr}; + } + + private: + /// input adapter + input_adapter_t ia = nullptr; + + /// the current character + int current = std::char_traits<char>::eof(); + + /// the number of characters read + std::size_t chars_read = 0; + + /// whether we can assume little endianess + const bool is_little_endian = little_endianess(); + + /// the SAX parser + json_sax_t* sax = nullptr; +}; +} +} + +// #include <nlohmann/detail/output/binary_writer.hpp> + + +#include <algorithm> // reverse +#include <array> // array +#include <cstdint> // uint8_t, uint16_t, uint32_t, uint64_t +#include <cstring> // memcpy +#include <limits> // numeric_limits + +// #include <nlohmann/detail/input/binary_reader.hpp> + +// #include <nlohmann/detail/output/output_adapters.hpp> + + +namespace nlohmann +{ +namespace detail +{ +/////////////////// +// binary writer // +/////////////////// + +/*! +@brief serialization to CBOR and MessagePack values +*/ +template<typename BasicJsonType, typename CharType> +class binary_writer +{ + public: + /*! + @brief create a binary writer + + @param[in] adapter output adapter to write to + */ + explicit binary_writer(output_adapter_t<CharType> adapter) : oa(adapter) + { + assert(oa); + } + + /*! + @brief[in] j JSON value to serialize + */ + void write_cbor(const BasicJsonType& j) + { + switch (j.type()) + { + case value_t::null: + { + oa->write_character(static_cast<CharType>(0xF6)); + break; + } + + case value_t::boolean: + { + oa->write_character(j.m_value.boolean + ? static_cast<CharType>(0xF5) + : static_cast<CharType>(0xF4)); + break; + } + + case value_t::number_integer: + { + if (j.m_value.number_integer >= 0) + { + // CBOR does not differentiate between positive signed + // integers and unsigned integers. Therefore, we used the + // code from the value_t::number_unsigned case here. + if (j.m_value.number_integer <= 0x17) + { + write_number(static_cast<uint8_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_integer <= (std::numeric_limits<uint8_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x18)); + write_number(static_cast<uint8_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_integer <= (std::numeric_limits<uint16_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x19)); + write_number(static_cast<uint16_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_integer <= (std::numeric_limits<uint32_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x1A)); + write_number(static_cast<uint32_t>(j.m_value.number_integer)); + } + else + { + oa->write_character(static_cast<CharType>(0x1B)); + write_number(static_cast<uint64_t>(j.m_value.number_integer)); + } + } + else + { + // The conversions below encode the sign in the first + // byte, and the value is converted to a positive number. + const auto positive_number = -1 - j.m_value.number_integer; + if (j.m_value.number_integer >= -24) + { + write_number(static_cast<uint8_t>(0x20 + positive_number)); + } + else if (positive_number <= (std::numeric_limits<uint8_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x38)); + write_number(static_cast<uint8_t>(positive_number)); + } + else if (positive_number <= (std::numeric_limits<uint16_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x39)); + write_number(static_cast<uint16_t>(positive_number)); + } + else if (positive_number <= (std::numeric_limits<uint32_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x3A)); + write_number(static_cast<uint32_t>(positive_number)); + } + else + { + oa->write_character(static_cast<CharType>(0x3B)); + write_number(static_cast<uint64_t>(positive_number)); + } + } + break; + } + + case value_t::number_unsigned: + { + if (j.m_value.number_unsigned <= 0x17) + { + write_number(static_cast<uint8_t>(j.m_value.number_unsigned)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x18)); + write_number(static_cast<uint8_t>(j.m_value.number_unsigned)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x19)); + write_number(static_cast<uint16_t>(j.m_value.number_unsigned)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x1A)); + write_number(static_cast<uint32_t>(j.m_value.number_unsigned)); + } + else + { + oa->write_character(static_cast<CharType>(0x1B)); + write_number(static_cast<uint64_t>(j.m_value.number_unsigned)); + } + break; + } + + case value_t::number_float: + { + oa->write_character(get_cbor_float_prefix(j.m_value.number_float)); + write_number(j.m_value.number_float); + break; + } + + case value_t::string: + { + // step 1: write control byte and the string length + const auto N = j.m_value.string->size(); + if (N <= 0x17) + { + write_number(static_cast<uint8_t>(0x60 + N)); + } + else if (N <= (std::numeric_limits<uint8_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x78)); + write_number(static_cast<uint8_t>(N)); + } + else if (N <= (std::numeric_limits<uint16_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x79)); + write_number(static_cast<uint16_t>(N)); + } + else if (N <= (std::numeric_limits<uint32_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x7A)); + write_number(static_cast<uint32_t>(N)); + } + // LCOV_EXCL_START + else if (N <= (std::numeric_limits<uint64_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x7B)); + write_number(static_cast<uint64_t>(N)); + } + // LCOV_EXCL_STOP + + // step 2: write the string + oa->write_characters( + reinterpret_cast<const CharType*>(j.m_value.string->c_str()), + j.m_value.string->size()); + break; + } + + case value_t::array: + { + // step 1: write control byte and the array size + const auto N = j.m_value.array->size(); + if (N <= 0x17) + { + write_number(static_cast<uint8_t>(0x80 + N)); + } + else if (N <= (std::numeric_limits<uint8_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x98)); + write_number(static_cast<uint8_t>(N)); + } + else if (N <= (std::numeric_limits<uint16_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x99)); + write_number(static_cast<uint16_t>(N)); + } + else if (N <= (std::numeric_limits<uint32_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x9A)); + write_number(static_cast<uint32_t>(N)); + } + // LCOV_EXCL_START + else if (N <= (std::numeric_limits<uint64_t>::max)()) + { + oa->write_character(static_cast<CharType>(0x9B)); + write_number(static_cast<uint64_t>(N)); + } + // LCOV_EXCL_STOP + + // step 2: write each element + for (const auto& el : *j.m_value.array) + { + write_cbor(el); + } + break; + } + + case value_t::object: + { + // step 1: write control byte and the object size + const auto N = j.m_value.object->size(); + if (N <= 0x17) + { + write_number(static_cast<uint8_t>(0xA0 + N)); + } + else if (N <= (std::numeric_limits<uint8_t>::max)()) + { + oa->write_character(static_cast<CharType>(0xB8)); + write_number(static_cast<uint8_t>(N)); + } + else if (N <= (std::numeric_limits<uint16_t>::max)()) + { + oa->write_character(static_cast<CharType>(0xB9)); + write_number(static_cast<uint16_t>(N)); + } + else if (N <= (std::numeric_limits<uint32_t>::max)()) + { + oa->write_character(static_cast<CharType>(0xBA)); + write_number(static_cast<uint32_t>(N)); + } + // LCOV_EXCL_START + else if (N <= (std::numeric_limits<uint64_t>::max)()) + { + oa->write_character(static_cast<CharType>(0xBB)); + write_number(static_cast<uint64_t>(N)); + } + // LCOV_EXCL_STOP + + // step 2: write each element + for (const auto& el : *j.m_value.object) + { + write_cbor(el.first); + write_cbor(el.second); + } + break; + } + + default: + break; + } + } + + /*! + @brief[in] j JSON value to serialize + */ + void write_msgpack(const BasicJsonType& j) + { + switch (j.type()) + { + case value_t::null: // nil + { + oa->write_character(static_cast<CharType>(0xC0)); + break; + } + + case value_t::boolean: // true and false + { + oa->write_character(j.m_value.boolean + ? static_cast<CharType>(0xC3) + : static_cast<CharType>(0xC2)); + break; + } + + case value_t::number_integer: + { + if (j.m_value.number_integer >= 0) + { + // MessagePack does not differentiate between positive + // signed integers and unsigned integers. Therefore, we used + // the code from the value_t::number_unsigned case here. + if (j.m_value.number_unsigned < 128) + { + // positive fixnum + write_number(static_cast<uint8_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)()) + { + // uint 8 + oa->write_character(static_cast<CharType>(0xCC)); + write_number(static_cast<uint8_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)()) + { + // uint 16 + oa->write_character(static_cast<CharType>(0xCD)); + write_number(static_cast<uint16_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)()) + { + // uint 32 + oa->write_character(static_cast<CharType>(0xCE)); + write_number(static_cast<uint32_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint64_t>::max)()) + { + // uint 64 + oa->write_character(static_cast<CharType>(0xCF)); + write_number(static_cast<uint64_t>(j.m_value.number_integer)); + } + } + else + { + if (j.m_value.number_integer >= -32) + { + // negative fixnum + write_number(static_cast<int8_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_integer >= (std::numeric_limits<int8_t>::min)() and + j.m_value.number_integer <= (std::numeric_limits<int8_t>::max)()) + { + // int 8 + oa->write_character(static_cast<CharType>(0xD0)); + write_number(static_cast<int8_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_integer >= (std::numeric_limits<int16_t>::min)() and + j.m_value.number_integer <= (std::numeric_limits<int16_t>::max)()) + { + // int 16 + oa->write_character(static_cast<CharType>(0xD1)); + write_number(static_cast<int16_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_integer >= (std::numeric_limits<int32_t>::min)() and + j.m_value.number_integer <= (std::numeric_limits<int32_t>::max)()) + { + // int 32 + oa->write_character(static_cast<CharType>(0xD2)); + write_number(static_cast<int32_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_integer >= (std::numeric_limits<int64_t>::min)() and + j.m_value.number_integer <= (std::numeric_limits<int64_t>::max)()) + { + // int 64 + oa->write_character(static_cast<CharType>(0xD3)); + write_number(static_cast<int64_t>(j.m_value.number_integer)); + } + } + break; + } + + case value_t::number_unsigned: + { + if (j.m_value.number_unsigned < 128) + { + // positive fixnum + write_number(static_cast<uint8_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)()) + { + // uint 8 + oa->write_character(static_cast<CharType>(0xCC)); + write_number(static_cast<uint8_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)()) + { + // uint 16 + oa->write_character(static_cast<CharType>(0xCD)); + write_number(static_cast<uint16_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)()) + { + // uint 32 + oa->write_character(static_cast<CharType>(0xCE)); + write_number(static_cast<uint32_t>(j.m_value.number_integer)); + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint64_t>::max)()) + { + // uint 64 + oa->write_character(static_cast<CharType>(0xCF)); + write_number(static_cast<uint64_t>(j.m_value.number_integer)); + } + break; + } + + case value_t::number_float: + { + oa->write_character(get_msgpack_float_prefix(j.m_value.number_float)); + write_number(j.m_value.number_float); + break; + } + + case value_t::string: + { + // step 1: write control byte and the string length + const auto N = j.m_value.string->size(); + if (N <= 31) + { + // fixstr + write_number(static_cast<uint8_t>(0xA0 | N)); + } + else if (N <= (std::numeric_limits<uint8_t>::max)()) + { + // str 8 + oa->write_character(static_cast<CharType>(0xD9)); + write_number(static_cast<uint8_t>(N)); + } + else if (N <= (std::numeric_limits<uint16_t>::max)()) + { + // str 16 + oa->write_character(static_cast<CharType>(0xDA)); + write_number(static_cast<uint16_t>(N)); + } + else if (N <= (std::numeric_limits<uint32_t>::max)()) + { + // str 32 + oa->write_character(static_cast<CharType>(0xDB)); + write_number(static_cast<uint32_t>(N)); + } + + // step 2: write the string + oa->write_characters( + reinterpret_cast<const CharType*>(j.m_value.string->c_str()), + j.m_value.string->size()); + break; + } + + case value_t::array: + { + // step 1: write control byte and the array size + const auto N = j.m_value.array->size(); + if (N <= 15) + { + // fixarray + write_number(static_cast<uint8_t>(0x90 | N)); + } + else if (N <= (std::numeric_limits<uint16_t>::max)()) + { + // array 16 + oa->write_character(static_cast<CharType>(0xDC)); + write_number(static_cast<uint16_t>(N)); + } + else if (N <= (std::numeric_limits<uint32_t>::max)()) + { + // array 32 + oa->write_character(static_cast<CharType>(0xDD)); + write_number(static_cast<uint32_t>(N)); + } + + // step 2: write each element + for (const auto& el : *j.m_value.array) + { + write_msgpack(el); + } + break; + } + + case value_t::object: + { + // step 1: write control byte and the object size + const auto N = j.m_value.object->size(); + if (N <= 15) + { + // fixmap + write_number(static_cast<uint8_t>(0x80 | (N & 0xF))); + } + else if (N <= (std::numeric_limits<uint16_t>::max)()) + { + // map 16 + oa->write_character(static_cast<CharType>(0xDE)); + write_number(static_cast<uint16_t>(N)); + } + else if (N <= (std::numeric_limits<uint32_t>::max)()) + { + // map 32 + oa->write_character(static_cast<CharType>(0xDF)); + write_number(static_cast<uint32_t>(N)); + } + + // step 2: write each element + for (const auto& el : *j.m_value.object) + { + write_msgpack(el.first); + write_msgpack(el.second); + } + break; + } + + default: + break; + } + } + + /*! + @param[in] j JSON value to serialize + @param[in] use_count whether to use '#' prefixes (optimized format) + @param[in] use_type whether to use '$' prefixes (optimized format) + @param[in] add_prefix whether prefixes need to be used for this value + */ + void write_ubjson(const BasicJsonType& j, const bool use_count, + const bool use_type, const bool add_prefix = true) + { + switch (j.type()) + { + case value_t::null: + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('Z')); + } + break; + } + + case value_t::boolean: + { + if (add_prefix) + oa->write_character(j.m_value.boolean + ? static_cast<CharType>('T') + : static_cast<CharType>('F')); + break; + } + + case value_t::number_integer: + { + write_number_with_ubjson_prefix(j.m_value.number_integer, add_prefix); + break; + } + + case value_t::number_unsigned: + { + write_number_with_ubjson_prefix(j.m_value.number_unsigned, add_prefix); + break; + } + + case value_t::number_float: + { + write_number_with_ubjson_prefix(j.m_value.number_float, add_prefix); + break; + } + + case value_t::string: + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('S')); + } + write_number_with_ubjson_prefix(j.m_value.string->size(), true); + oa->write_characters( + reinterpret_cast<const CharType*>(j.m_value.string->c_str()), + j.m_value.string->size()); + break; + } + + case value_t::array: + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('[')); + } + + bool prefix_required = true; + if (use_type and not j.m_value.array->empty()) + { + assert(use_count); + const CharType first_prefix = ubjson_prefix(j.front()); + const bool same_prefix = std::all_of(j.begin() + 1, j.end(), + [this, first_prefix](const BasicJsonType & v) + { + return ubjson_prefix(v) == first_prefix; + }); + + if (same_prefix) + { + prefix_required = false; + oa->write_character(static_cast<CharType>('$')); + oa->write_character(first_prefix); + } + } + + if (use_count) + { + oa->write_character(static_cast<CharType>('#')); + write_number_with_ubjson_prefix(j.m_value.array->size(), true); + } + + for (const auto& el : *j.m_value.array) + { + write_ubjson(el, use_count, use_type, prefix_required); + } + + if (not use_count) + { + oa->write_character(static_cast<CharType>(']')); + } + + break; + } + + case value_t::object: + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('{')); + } + + bool prefix_required = true; + if (use_type and not j.m_value.object->empty()) + { + assert(use_count); + const CharType first_prefix = ubjson_prefix(j.front()); + const bool same_prefix = std::all_of(j.begin(), j.end(), + [this, first_prefix](const BasicJsonType & v) + { + return ubjson_prefix(v) == first_prefix; + }); + + if (same_prefix) + { + prefix_required = false; + oa->write_character(static_cast<CharType>('$')); + oa->write_character(first_prefix); + } + } + + if (use_count) + { + oa->write_character(static_cast<CharType>('#')); + write_number_with_ubjson_prefix(j.m_value.object->size(), true); + } + + for (const auto& el : *j.m_value.object) + { + write_number_with_ubjson_prefix(el.first.size(), true); + oa->write_characters( + reinterpret_cast<const CharType*>(el.first.c_str()), + el.first.size()); + write_ubjson(el.second, use_count, use_type, prefix_required); + } + + if (not use_count) + { + oa->write_character(static_cast<CharType>('}')); + } + + break; + } + + default: + break; + } + } + + private: + /* + @brief write a number to output input + + @param[in] n number of type @a NumberType + @tparam NumberType the type of the number + + @note This function needs to respect the system's endianess, because bytes + in CBOR, MessagePack, and UBJSON are stored in network order (big + endian) and therefore need reordering on little endian systems. + */ + template<typename NumberType> + void write_number(const NumberType n) + { + // step 1: write number to array of length NumberType + std::array<CharType, sizeof(NumberType)> vec; + std::memcpy(vec.data(), &n, sizeof(NumberType)); + + // step 2: write array to output (with possible reordering) + if (is_little_endian) + { + // reverse byte order prior to conversion if necessary + std::reverse(vec.begin(), vec.end()); + } + + oa->write_characters(vec.data(), sizeof(NumberType)); + } + + // UBJSON: write number (floating point) + template<typename NumberType, typename std::enable_if< + std::is_floating_point<NumberType>::value, int>::type = 0> + void write_number_with_ubjson_prefix(const NumberType n, + const bool add_prefix) + { + if (add_prefix) + { + oa->write_character(get_ubjson_float_prefix(n)); + } + write_number(n); + } + + // UBJSON: write number (unsigned integer) + template<typename NumberType, typename std::enable_if< + std::is_unsigned<NumberType>::value, int>::type = 0> + void write_number_with_ubjson_prefix(const NumberType n, + const bool add_prefix) + { + if (n <= static_cast<uint64_t>((std::numeric_limits<int8_t>::max)())) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('i')); // int8 + } + write_number(static_cast<uint8_t>(n)); + } + else if (n <= (std::numeric_limits<uint8_t>::max)()) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('U')); // uint8 + } + write_number(static_cast<uint8_t>(n)); + } + else if (n <= static_cast<uint64_t>((std::numeric_limits<int16_t>::max)())) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('I')); // int16 + } + write_number(static_cast<int16_t>(n)); + } + else if (n <= static_cast<uint64_t>((std::numeric_limits<int32_t>::max)())) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('l')); // int32 + } + write_number(static_cast<int32_t>(n)); + } + else if (n <= static_cast<uint64_t>((std::numeric_limits<int64_t>::max)())) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('L')); // int64 + } + write_number(static_cast<int64_t>(n)); + } + else + { + JSON_THROW(out_of_range::create(407, "number overflow serializing " + std::to_string(n))); + } + } + + // UBJSON: write number (signed integer) + template<typename NumberType, typename std::enable_if< + std::is_signed<NumberType>::value and + not std::is_floating_point<NumberType>::value, int>::type = 0> + void write_number_with_ubjson_prefix(const NumberType n, + const bool add_prefix) + { + if ((std::numeric_limits<int8_t>::min)() <= n and n <= (std::numeric_limits<int8_t>::max)()) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('i')); // int8 + } + write_number(static_cast<int8_t>(n)); + } + else if (static_cast<int64_t>((std::numeric_limits<uint8_t>::min)()) <= n and n <= static_cast<int64_t>((std::numeric_limits<uint8_t>::max)())) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('U')); // uint8 + } + write_number(static_cast<uint8_t>(n)); + } + else if ((std::numeric_limits<int16_t>::min)() <= n and n <= (std::numeric_limits<int16_t>::max)()) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('I')); // int16 + } + write_number(static_cast<int16_t>(n)); + } + else if ((std::numeric_limits<int32_t>::min)() <= n and n <= (std::numeric_limits<int32_t>::max)()) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('l')); // int32 + } + write_number(static_cast<int32_t>(n)); + } + else if ((std::numeric_limits<int64_t>::min)() <= n and n <= (std::numeric_limits<int64_t>::max)()) + { + if (add_prefix) + { + oa->write_character(static_cast<CharType>('L')); // int64 + } + write_number(static_cast<int64_t>(n)); + } + // LCOV_EXCL_START + else + { + JSON_THROW(out_of_range::create(407, "number overflow serializing " + std::to_string(n))); + } + // LCOV_EXCL_STOP + } + + /*! + @brief determine the type prefix of container values + + @note This function does not need to be 100% accurate when it comes to + integer limits. In case a number exceeds the limits of int64_t, + this will be detected by a later call to function + write_number_with_ubjson_prefix. Therefore, we return 'L' for any + value that does not fit the previous limits. + */ + CharType ubjson_prefix(const BasicJsonType& j) const noexcept + { + switch (j.type()) + { + case value_t::null: + return 'Z'; + + case value_t::boolean: + return j.m_value.boolean ? 'T' : 'F'; + + case value_t::number_integer: + { + if ((std::numeric_limits<int8_t>::min)() <= j.m_value.number_integer and j.m_value.number_integer <= (std::numeric_limits<int8_t>::max)()) + { + return 'i'; + } + else if ((std::numeric_limits<uint8_t>::min)() <= j.m_value.number_integer and j.m_value.number_integer <= (std::numeric_limits<uint8_t>::max)()) + { + return 'U'; + } + else if ((std::numeric_limits<int16_t>::min)() <= j.m_value.number_integer and j.m_value.number_integer <= (std::numeric_limits<int16_t>::max)()) + { + return 'I'; + } + else if ((std::numeric_limits<int32_t>::min)() <= j.m_value.number_integer and j.m_value.number_integer <= (std::numeric_limits<int32_t>::max)()) + { + return 'l'; + } + else // no check and assume int64_t (see note above) + { + return 'L'; + } + } + + case value_t::number_unsigned: + { + if (j.m_value.number_unsigned <= (std::numeric_limits<int8_t>::max)()) + { + return 'i'; + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)()) + { + return 'U'; + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<int16_t>::max)()) + { + return 'I'; + } + else if (j.m_value.number_unsigned <= (std::numeric_limits<int32_t>::max)()) + { + return 'l'; + } + else // no check and assume int64_t (see note above) + { + return 'L'; + } + } + + case value_t::number_float: + return get_ubjson_float_prefix(j.m_value.number_float); + + case value_t::string: + return 'S'; + + case value_t::array: + return '['; + + case value_t::object: + return '{'; + + default: // discarded values + return 'N'; + } + } + + static constexpr CharType get_cbor_float_prefix(float) + { + return static_cast<CharType>(0xFA); // Single-Precision Float + } + + static constexpr CharType get_cbor_float_prefix(double) + { + return static_cast<CharType>(0xFB); // Double-Precision Float + } + + static constexpr CharType get_msgpack_float_prefix(float) + { + return static_cast<CharType>(0xCA); // float 32 + } + + static constexpr CharType get_msgpack_float_prefix(double) + { + return static_cast<CharType>(0xCB); // float 64 + } + + static constexpr CharType get_ubjson_float_prefix(float) + { + return 'd'; // float 32 + } + + static constexpr CharType get_ubjson_float_prefix(double) + { + return 'D'; // float 64 + } + + private: + /// whether we can assume little endianess + const bool is_little_endian = binary_reader<BasicJsonType>::little_endianess(); + + /// the output + output_adapter_t<CharType> oa = nullptr; +}; +} +} + +// #include <nlohmann/detail/output/serializer.hpp> + + +#include <algorithm> // reverse, remove, fill, find, none_of +#include <array> // array +#include <cassert> // assert +#include <ciso646> // and, or +#include <clocale> // localeconv, lconv +#include <cmath> // labs, isfinite, isnan, signbit +#include <cstddef> // size_t, ptrdiff_t +#include <cstdint> // uint8_t +#include <cstdio> // snprintf +#include <limits> // numeric_limits +#include <string> // string +#include <type_traits> // is_same + +// #include <nlohmann/detail/exceptions.hpp> + +// #include <nlohmann/detail/conversions/to_chars.hpp> + + +#include <cassert> // assert +#include <ciso646> // or, and, not +#include <cmath> // signbit, isfinite +#include <cstdint> // intN_t, uintN_t +#include <cstring> // memcpy, memmove + +namespace nlohmann +{ +namespace detail +{ + +/*! +@brief implements the Grisu2 algorithm for binary to decimal floating-point +conversion. + +This implementation is a slightly modified version of the reference +implementation which may be obtained from +http://florian.loitsch.com/publications (bench.tar.gz). + +The code is distributed under the MIT license, Copyright (c) 2009 Florian Loitsch. + +For a detailed description of the algorithm see: + +[1] Loitsch, "Printing Floating-Point Numbers Quickly and Accurately with + Integers", Proceedings of the ACM SIGPLAN 2010 Conference on Programming + Language Design and Implementation, PLDI 2010 +[2] Burger, Dybvig, "Printing Floating-Point Numbers Quickly and Accurately", + Proceedings of the ACM SIGPLAN 1996 Conference on Programming Language + Design and Implementation, PLDI 1996 +*/ +namespace dtoa_impl +{ + +template <typename Target, typename Source> +Target reinterpret_bits(const Source source) +{ + static_assert(sizeof(Target) == sizeof(Source), "size mismatch"); + + Target target; + std::memcpy(&target, &source, sizeof(Source)); + return target; +} + +struct diyfp // f * 2^e +{ + static constexpr int kPrecision = 64; // = q + + uint64_t f; + int e; + + constexpr diyfp() noexcept : f(0), e(0) {} + constexpr diyfp(uint64_t f_, int e_) noexcept : f(f_), e(e_) {} + + /*! + @brief returns x - y + @pre x.e == y.e and x.f >= y.f + */ + static diyfp sub(const diyfp& x, const diyfp& y) noexcept + { + assert(x.e == y.e); + assert(x.f >= y.f); + + return diyfp(x.f - y.f, x.e); + } + + /*! + @brief returns x * y + @note The result is rounded. (Only the upper q bits are returned.) + */ + static diyfp mul(const diyfp& x, const diyfp& y) noexcept + { + static_assert(kPrecision == 64, "internal error"); + + // Computes: + // f = round((x.f * y.f) / 2^q) + // e = x.e + y.e + q + + // Emulate the 64-bit * 64-bit multiplication: + // + // p = u * v + // = (u_lo + 2^32 u_hi) (v_lo + 2^32 v_hi) + // = (u_lo v_lo ) + 2^32 ((u_lo v_hi ) + (u_hi v_lo )) + 2^64 (u_hi v_hi ) + // = (p0 ) + 2^32 ((p1 ) + (p2 )) + 2^64 (p3 ) + // = (p0_lo + 2^32 p0_hi) + 2^32 ((p1_lo + 2^32 p1_hi) + (p2_lo + 2^32 p2_hi)) + 2^64 (p3 ) + // = (p0_lo ) + 2^32 (p0_hi + p1_lo + p2_lo ) + 2^64 (p1_hi + p2_hi + p3) + // = (p0_lo ) + 2^32 (Q ) + 2^64 (H ) + // = (p0_lo ) + 2^32 (Q_lo + 2^32 Q_hi ) + 2^64 (H ) + // + // (Since Q might be larger than 2^32 - 1) + // + // = (p0_lo + 2^32 Q_lo) + 2^64 (Q_hi + H) + // + // (Q_hi + H does not overflow a 64-bit int) + // + // = p_lo + 2^64 p_hi + + const uint64_t u_lo = x.f & 0xFFFFFFFF; + const uint64_t u_hi = x.f >> 32; + const uint64_t v_lo = y.f & 0xFFFFFFFF; + const uint64_t v_hi = y.f >> 32; + + const uint64_t p0 = u_lo * v_lo; + const uint64_t p1 = u_lo * v_hi; + const uint64_t p2 = u_hi * v_lo; + const uint64_t p3 = u_hi * v_hi; + + const uint64_t p0_hi = p0 >> 32; + const uint64_t p1_lo = p1 & 0xFFFFFFFF; + const uint64_t p1_hi = p1 >> 32; + const uint64_t p2_lo = p2 & 0xFFFFFFFF; + const uint64_t p2_hi = p2 >> 32; + + uint64_t Q = p0_hi + p1_lo + p2_lo; + + // The full product might now be computed as + // + // p_hi = p3 + p2_hi + p1_hi + (Q >> 32) + // p_lo = p0_lo + (Q << 32) + // + // But in this particular case here, the full p_lo is not required. + // Effectively we only need to add the highest bit in p_lo to p_hi (and + // Q_hi + 1 does not overflow). + + Q += uint64_t{1} << (64 - 32 - 1); // round, ties up + + const uint64_t h = p3 + p2_hi + p1_hi + (Q >> 32); + + return diyfp(h, x.e + y.e + 64); + } + + /*! + @brief normalize x such that the significand is >= 2^(q-1) + @pre x.f != 0 + */ + static diyfp normalize(diyfp x) noexcept + { + assert(x.f != 0); + + while ((x.f >> 63) == 0) + { + x.f <<= 1; + x.e--; + } + + return x; + } + + /*! + @brief normalize x such that the result has the exponent E + @pre e >= x.e and the upper e - x.e bits of x.f must be zero. + */ + static diyfp normalize_to(const diyfp& x, const int target_exponent) noexcept + { + const int delta = x.e - target_exponent; + + assert(delta >= 0); + assert(((x.f << delta) >> delta) == x.f); + + return diyfp(x.f << delta, target_exponent); + } +}; + +struct boundaries +{ + diyfp w; + diyfp minus; + diyfp plus; +}; + +/*! +Compute the (normalized) diyfp representing the input number 'value' and its +boundaries. + +@pre value must be finite and positive +*/ +template <typename FloatType> +boundaries compute_boundaries(FloatType value) +{ + assert(std::isfinite(value)); + assert(value > 0); + + // Convert the IEEE representation into a diyfp. + // + // If v is denormal: + // value = 0.F * 2^(1 - bias) = ( F) * 2^(1 - bias - (p-1)) + // If v is normalized: + // value = 1.F * 2^(E - bias) = (2^(p-1) + F) * 2^(E - bias - (p-1)) + + static_assert(std::numeric_limits<FloatType>::is_iec559, + "internal error: dtoa_short requires an IEEE-754 floating-point implementation"); + + constexpr int kPrecision = std::numeric_limits<FloatType>::digits; // = p (includes the hidden bit) + constexpr int kBias = std::numeric_limits<FloatType>::max_exponent - 1 + (kPrecision - 1); + constexpr int kMinExp = 1 - kBias; + constexpr uint64_t kHiddenBit = uint64_t{1} << (kPrecision - 1); // = 2^(p-1) + + using bits_type = typename std::conditional< kPrecision == 24, uint32_t, uint64_t >::type; + + const uint64_t bits = reinterpret_bits<bits_type>(value); + const uint64_t E = bits >> (kPrecision - 1); + const uint64_t F = bits & (kHiddenBit - 1); + + const bool is_denormal = (E == 0); + const diyfp v = is_denormal + ? diyfp(F, kMinExp) + : diyfp(F + kHiddenBit, static_cast<int>(E) - kBias); + + // Compute the boundaries m- and m+ of the floating-point value + // v = f * 2^e. + // + // Determine v- and v+, the floating-point predecessor and successor if v, + // respectively. + // + // v- = v - 2^e if f != 2^(p-1) or e == e_min (A) + // = v - 2^(e-1) if f == 2^(p-1) and e > e_min (B) + // + // v+ = v + 2^e + // + // Let m- = (v- + v) / 2 and m+ = (v + v+) / 2. All real numbers _strictly_ + // between m- and m+ round to v, regardless of how the input rounding + // algorithm breaks ties. + // + // ---+-------------+-------------+-------------+-------------+--- (A) + // v- m- v m+ v+ + // + // -----------------+------+------+-------------+-------------+--- (B) + // v- m- v m+ v+ + + const bool lower_boundary_is_closer = (F == 0 and E > 1); + const diyfp m_plus = diyfp(2 * v.f + 1, v.e - 1); + const diyfp m_minus = lower_boundary_is_closer + ? diyfp(4 * v.f - 1, v.e - 2) // (B) + : diyfp(2 * v.f - 1, v.e - 1); // (A) + + // Determine the normalized w+ = m+. + const diyfp w_plus = diyfp::normalize(m_plus); + + // Determine w- = m- such that e_(w-) = e_(w+). + const diyfp w_minus = diyfp::normalize_to(m_minus, w_plus.e); + + return {diyfp::normalize(v), w_minus, w_plus}; +} + +// Given normalized diyfp w, Grisu needs to find a (normalized) cached +// power-of-ten c, such that the exponent of the product c * w = f * 2^e lies +// within a certain range [alpha, gamma] (Definition 3.2 from [1]) +// +// alpha <= e = e_c + e_w + q <= gamma +// +// or +// +// f_c * f_w * 2^alpha <= f_c 2^(e_c) * f_w 2^(e_w) * 2^q +// <= f_c * f_w * 2^gamma +// +// Since c and w are normalized, i.e. 2^(q-1) <= f < 2^q, this implies +// +// 2^(q-1) * 2^(q-1) * 2^alpha <= c * w * 2^q < 2^q * 2^q * 2^gamma +// +// or +// +// 2^(q - 2 + alpha) <= c * w < 2^(q + gamma) +// +// The choice of (alpha,gamma) determines the size of the table and the form of +// the digit generation procedure. Using (alpha,gamma)=(-60,-32) works out well +// in practice: +// +// The idea is to cut the number c * w = f * 2^e into two parts, which can be +// processed independently: An integral part p1, and a fractional part p2: +// +// f * 2^e = ( (f div 2^-e) * 2^-e + (f mod 2^-e) ) * 2^e +// = (f div 2^-e) + (f mod 2^-e) * 2^e +// = p1 + p2 * 2^e +// +// The conversion of p1 into decimal form requires a series of divisions and +// modulos by (a power of) 10. These operations are faster for 32-bit than for +// 64-bit integers, so p1 should ideally fit into a 32-bit integer. This can be +// achieved by choosing +// +// -e >= 32 or e <= -32 := gamma +// +// In order to convert the fractional part +// +// p2 * 2^e = p2 / 2^-e = d[-1] / 10^1 + d[-2] / 10^2 + ... +// +// into decimal form, the fraction is repeatedly multiplied by 10 and the digits +// d[-i] are extracted in order: +// +// (10 * p2) div 2^-e = d[-1] +// (10 * p2) mod 2^-e = d[-2] / 10^1 + ... +// +// The multiplication by 10 must not overflow. It is sufficient to choose +// +// 10 * p2 < 16 * p2 = 2^4 * p2 <= 2^64. +// +// Since p2 = f mod 2^-e < 2^-e, +// +// -e <= 60 or e >= -60 := alpha + +constexpr int kAlpha = -60; +constexpr int kGamma = -32; + +struct cached_power // c = f * 2^e ~= 10^k +{ + uint64_t f; + int e; + int k; +}; + +/*! +For a normalized diyfp w = f * 2^e, this function returns a (normalized) cached +power-of-ten c = f_c * 2^e_c, such that the exponent of the product w * c +satisfies (Definition 3.2 from [1]) + + alpha <= e_c + e + q <= gamma. +*/ +inline cached_power get_cached_power_for_binary_exponent(int e) +{ + // Now + // + // alpha <= e_c + e + q <= gamma (1) + // ==> f_c * 2^alpha <= c * 2^e * 2^q + // + // and since the c's are normalized, 2^(q-1) <= f_c, + // + // ==> 2^(q - 1 + alpha) <= c * 2^(e + q) + // ==> 2^(alpha - e - 1) <= c + // + // If c were an exakt power of ten, i.e. c = 10^k, one may determine k as + // + // k = ceil( log_10( 2^(alpha - e - 1) ) ) + // = ceil( (alpha - e - 1) * log_10(2) ) + // + // From the paper: + // "In theory the result of the procedure could be wrong since c is rounded, + // and the computation itself is approximated [...]. In practice, however, + // this simple function is sufficient." + // + // For IEEE double precision floating-point numbers converted into + // normalized diyfp's w = f * 2^e, with q = 64, + // + // e >= -1022 (min IEEE exponent) + // -52 (p - 1) + // -52 (p - 1, possibly normalize denormal IEEE numbers) + // -11 (normalize the diyfp) + // = -1137 + // + // and + // + // e <= +1023 (max IEEE exponent) + // -52 (p - 1) + // -11 (normalize the diyfp) + // = 960 + // + // This binary exponent range [-1137,960] results in a decimal exponent + // range [-307,324]. One does not need to store a cached power for each + // k in this range. For each such k it suffices to find a cached power + // such that the exponent of the product lies in [alpha,gamma]. + // This implies that the difference of the decimal exponents of adjacent + // table entries must be less than or equal to + // + // floor( (gamma - alpha) * log_10(2) ) = 8. + // + // (A smaller distance gamma-alpha would require a larger table.) + + // NB: + // Actually this function returns c, such that -60 <= e_c + e + 64 <= -34. + + constexpr int kCachedPowersSize = 79; + constexpr int kCachedPowersMinDecExp = -300; + constexpr int kCachedPowersDecStep = 8; + + static constexpr cached_power kCachedPowers[] = + { + { 0xAB70FE17C79AC6CA, -1060, -300 }, + { 0xFF77B1FCBEBCDC4F, -1034, -292 }, + { 0xBE5691EF416BD60C, -1007, -284 }, + { 0x8DD01FAD907FFC3C, -980, -276 }, + { 0xD3515C2831559A83, -954, -268 }, + { 0x9D71AC8FADA6C9B5, -927, -260 }, + { 0xEA9C227723EE8BCB, -901, -252 }, + { 0xAECC49914078536D, -874, -244 }, + { 0x823C12795DB6CE57, -847, -236 }, + { 0xC21094364DFB5637, -821, -228 }, + { 0x9096EA6F3848984F, -794, -220 }, + { 0xD77485CB25823AC7, -768, -212 }, + { 0xA086CFCD97BF97F4, -741, -204 }, + { 0xEF340A98172AACE5, -715, -196 }, + { 0xB23867FB2A35B28E, -688, -188 }, + { 0x84C8D4DFD2C63F3B, -661, -180 }, + { 0xC5DD44271AD3CDBA, -635, -172 }, + { 0x936B9FCEBB25C996, -608, -164 }, + { 0xDBAC6C247D62A584, -582, -156 }, + { 0xA3AB66580D5FDAF6, -555, -148 }, + { 0xF3E2F893DEC3F126, -529, -140 }, + { 0xB5B5ADA8AAFF80B8, -502, -132 }, + { 0x87625F056C7C4A8B, -475, -124 }, + { 0xC9BCFF6034C13053, -449, -116 }, + { 0x964E858C91BA2655, -422, -108 }, + { 0xDFF9772470297EBD, -396, -100 }, + { 0xA6DFBD9FB8E5B88F, -369, -92 }, + { 0xF8A95FCF88747D94, -343, -84 }, + { 0xB94470938FA89BCF, -316, -76 }, + { 0x8A08F0F8BF0F156B, -289, -68 }, + { 0xCDB02555653131B6, -263, -60 }, + { 0x993FE2C6D07B7FAC, -236, -52 }, + { 0xE45C10C42A2B3B06, -210, -44 }, + { 0xAA242499697392D3, -183, -36 }, + { 0xFD87B5F28300CA0E, -157, -28 }, + { 0xBCE5086492111AEB, -130, -20 }, + { 0x8CBCCC096F5088CC, -103, -12 }, + { 0xD1B71758E219652C, -77, -4 }, + { 0x9C40000000000000, -50, 4 }, + { 0xE8D4A51000000000, -24, 12 }, + { 0xAD78EBC5AC620000, 3, 20 }, + { 0x813F3978F8940984, 30, 28 }, + { 0xC097CE7BC90715B3, 56, 36 }, + { 0x8F7E32CE7BEA5C70, 83, 44 }, + { 0xD5D238A4ABE98068, 109, 52 }, + { 0x9F4F2726179A2245, 136, 60 }, + { 0xED63A231D4C4FB27, 162, 68 }, + { 0xB0DE65388CC8ADA8, 189, 76 }, + { 0x83C7088E1AAB65DB, 216, 84 }, + { 0xC45D1DF942711D9A, 242, 92 }, + { 0x924D692CA61BE758, 269, 100 }, + { 0xDA01EE641A708DEA, 295, 108 }, + { 0xA26DA3999AEF774A, 322, 116 }, + { 0xF209787BB47D6B85, 348, 124 }, + { 0xB454E4A179DD1877, 375, 132 }, + { 0x865B86925B9BC5C2, 402, 140 }, + { 0xC83553C5C8965D3D, 428, 148 }, + { 0x952AB45CFA97A0B3, 455, 156 }, + { 0xDE469FBD99A05FE3, 481, 164 }, + { 0xA59BC234DB398C25, 508, 172 }, + { 0xF6C69A72A3989F5C, 534, 180 }, + { 0xB7DCBF5354E9BECE, 561, 188 }, + { 0x88FCF317F22241E2, 588, 196 }, + { 0xCC20CE9BD35C78A5, 614, 204 }, + { 0x98165AF37B2153DF, 641, 212 }, + { 0xE2A0B5DC971F303A, 667, 220 }, + { 0xA8D9D1535CE3B396, 694, 228 }, + { 0xFB9B7CD9A4A7443C, 720, 236 }, + { 0xBB764C4CA7A44410, 747, 244 }, + { 0x8BAB8EEFB6409C1A, 774, 252 }, + { 0xD01FEF10A657842C, 800, 260 }, + { 0x9B10A4E5E9913129, 827, 268 }, + { 0xE7109BFBA19C0C9D, 853, 276 }, + { 0xAC2820D9623BF429, 880, 284 }, + { 0x80444B5E7AA7CF85, 907, 292 }, + { 0xBF21E44003ACDD2D, 933, 300 }, + { 0x8E679C2F5E44FF8F, 960, 308 }, + { 0xD433179D9C8CB841, 986, 316 }, + { 0x9E19DB92B4E31BA9, 1013, 324 }, + }; + + // This computation gives exactly the same results for k as + // k = ceil((kAlpha - e - 1) * 0.30102999566398114) + // for |e| <= 1500, but doesn't require floating-point operations. + // NB: log_10(2) ~= 78913 / 2^18 + assert(e >= -1500); + assert(e <= 1500); + const int f = kAlpha - e - 1; + const int k = (f * 78913) / (1 << 18) + (f > 0); + + const int index = (-kCachedPowersMinDecExp + k + (kCachedPowersDecStep - 1)) / kCachedPowersDecStep; + assert(index >= 0); + assert(index < kCachedPowersSize); + static_cast<void>(kCachedPowersSize); // Fix warning. + + const cached_power cached = kCachedPowers[index]; + assert(kAlpha <= cached.e + e + 64); + assert(kGamma >= cached.e + e + 64); + + return cached; +} + +/*! +For n != 0, returns k, such that pow10 := 10^(k-1) <= n < 10^k. +For n == 0, returns 1 and sets pow10 := 1. +*/ +inline int find_largest_pow10(const uint32_t n, uint32_t& pow10) +{ + // LCOV_EXCL_START + if (n >= 1000000000) + { + pow10 = 1000000000; + return 10; + } + // LCOV_EXCL_STOP + else if (n >= 100000000) + { + pow10 = 100000000; + return 9; + } + else if (n >= 10000000) + { + pow10 = 10000000; + return 8; + } + else if (n >= 1000000) + { + pow10 = 1000000; + return 7; + } + else if (n >= 100000) + { + pow10 = 100000; + return 6; + } + else if (n >= 10000) + { + pow10 = 10000; + return 5; + } + else if (n >= 1000) + { + pow10 = 1000; + return 4; + } + else if (n >= 100) + { + pow10 = 100; + return 3; + } + else if (n >= 10) + { + pow10 = 10; + return 2; + } + else + { + pow10 = 1; + return 1; + } +} + +inline void grisu2_round(char* buf, int len, uint64_t dist, uint64_t delta, + uint64_t rest, uint64_t ten_k) +{ + assert(len >= 1); + assert(dist <= delta); + assert(rest <= delta); + assert(ten_k > 0); + + // <--------------------------- delta ----> + // <---- dist ---------> + // --------------[------------------+-------------------]-------------- + // M- w M+ + // + // ten_k + // <------> + // <---- rest ----> + // --------------[------------------+----+--------------]-------------- + // w V + // = buf * 10^k + // + // ten_k represents a unit-in-the-last-place in the decimal representation + // stored in buf. + // Decrement buf by ten_k while this takes buf closer to w. + + // The tests are written in this order to avoid overflow in unsigned + // integer arithmetic. + + while (rest < dist + and delta - rest >= ten_k + and (rest + ten_k < dist or dist - rest > rest + ten_k - dist)) + { + assert(buf[len - 1] != '0'); + buf[len - 1]--; + rest += ten_k; + } +} + +/*! +Generates V = buffer * 10^decimal_exponent, such that M- <= V <= M+. +M- and M+ must be normalized and share the same exponent -60 <= e <= -32. +*/ +inline void grisu2_digit_gen(char* buffer, int& length, int& decimal_exponent, + diyfp M_minus, diyfp w, diyfp M_plus) +{ + static_assert(kAlpha >= -60, "internal error"); + static_assert(kGamma <= -32, "internal error"); + + // Generates the digits (and the exponent) of a decimal floating-point + // number V = buffer * 10^decimal_exponent in the range [M-, M+]. The diyfp's + // w, M- and M+ share the same exponent e, which satisfies alpha <= e <= gamma. + // + // <--------------------------- delta ----> + // <---- dist ---------> + // --------------[------------------+-------------------]-------------- + // M- w M+ + // + // Grisu2 generates the digits of M+ from left to right and stops as soon as + // V is in [M-,M+]. + + assert(M_plus.e >= kAlpha); + assert(M_plus.e <= kGamma); + + uint64_t delta = diyfp::sub(M_plus, M_minus).f; // (significand of (M+ - M-), implicit exponent is e) + uint64_t dist = diyfp::sub(M_plus, w ).f; // (significand of (M+ - w ), implicit exponent is e) + + // Split M+ = f * 2^e into two parts p1 and p2 (note: e < 0): + // + // M+ = f * 2^e + // = ((f div 2^-e) * 2^-e + (f mod 2^-e)) * 2^e + // = ((p1 ) * 2^-e + (p2 )) * 2^e + // = p1 + p2 * 2^e + + const diyfp one(uint64_t{1} << -M_plus.e, M_plus.e); + + uint32_t p1 = static_cast<uint32_t>(M_plus.f >> -one.e); // p1 = f div 2^-e (Since -e >= 32, p1 fits into a 32-bit int.) + uint64_t p2 = M_plus.f & (one.f - 1); // p2 = f mod 2^-e + + // 1) + // + // Generate the digits of the integral part p1 = d[n-1]...d[1]d[0] + + assert(p1 > 0); + + uint32_t pow10; + const int k = find_largest_pow10(p1, pow10); + + // 10^(k-1) <= p1 < 10^k, pow10 = 10^(k-1) + // + // p1 = (p1 div 10^(k-1)) * 10^(k-1) + (p1 mod 10^(k-1)) + // = (d[k-1] ) * 10^(k-1) + (p1 mod 10^(k-1)) + // + // M+ = p1 + p2 * 2^e + // = d[k-1] * 10^(k-1) + (p1 mod 10^(k-1)) + p2 * 2^e + // = d[k-1] * 10^(k-1) + ((p1 mod 10^(k-1)) * 2^-e + p2) * 2^e + // = d[k-1] * 10^(k-1) + ( rest) * 2^e + // + // Now generate the digits d[n] of p1 from left to right (n = k-1,...,0) + // + // p1 = d[k-1]...d[n] * 10^n + d[n-1]...d[0] + // + // but stop as soon as + // + // rest * 2^e = (d[n-1]...d[0] * 2^-e + p2) * 2^e <= delta * 2^e + + int n = k; + while (n > 0) + { + // Invariants: + // M+ = buffer * 10^n + (p1 + p2 * 2^e) (buffer = 0 for n = k) + // pow10 = 10^(n-1) <= p1 < 10^n + // + const uint32_t d = p1 / pow10; // d = p1 div 10^(n-1) + const uint32_t r = p1 % pow10; // r = p1 mod 10^(n-1) + // + // M+ = buffer * 10^n + (d * 10^(n-1) + r) + p2 * 2^e + // = (buffer * 10 + d) * 10^(n-1) + (r + p2 * 2^e) + // + assert(d <= 9); + buffer[length++] = static_cast<char>('0' + d); // buffer := buffer * 10 + d + // + // M+ = buffer * 10^(n-1) + (r + p2 * 2^e) + // + p1 = r; + n--; + // + // M+ = buffer * 10^n + (p1 + p2 * 2^e) + // pow10 = 10^n + // + + // Now check if enough digits have been generated. + // Compute + // + // p1 + p2 * 2^e = (p1 * 2^-e + p2) * 2^e = rest * 2^e + // + // Note: + // Since rest and delta share the same exponent e, it suffices to + // compare the significands. + const uint64_t rest = (uint64_t{p1} << -one.e) + p2; + if (rest <= delta) + { + // V = buffer * 10^n, with M- <= V <= M+. + + decimal_exponent += n; + + // We may now just stop. But instead look if the buffer could be + // decremented to bring V closer to w. + // + // pow10 = 10^n is now 1 ulp in the decimal representation V. + // The rounding procedure works with diyfp's with an implicit + // exponent of e. + // + // 10^n = (10^n * 2^-e) * 2^e = ulp * 2^e + // + const uint64_t ten_n = uint64_t{pow10} << -one.e; + grisu2_round(buffer, length, dist, delta, rest, ten_n); + + return; + } + + pow10 /= 10; + // + // pow10 = 10^(n-1) <= p1 < 10^n + // Invariants restored. + } + + // 2) + // + // The digits of the integral part have been generated: + // + // M+ = d[k-1]...d[1]d[0] + p2 * 2^e + // = buffer + p2 * 2^e + // + // Now generate the digits of the fractional part p2 * 2^e. + // + // Note: + // No decimal point is generated: the exponent is adjusted instead. + // + // p2 actually represents the fraction + // + // p2 * 2^e + // = p2 / 2^-e + // = d[-1] / 10^1 + d[-2] / 10^2 + ... + // + // Now generate the digits d[-m] of p1 from left to right (m = 1,2,...) + // + // p2 * 2^e = d[-1]d[-2]...d[-m] * 10^-m + // + 10^-m * (d[-m-1] / 10^1 + d[-m-2] / 10^2 + ...) + // + // using + // + // 10^m * p2 = ((10^m * p2) div 2^-e) * 2^-e + ((10^m * p2) mod 2^-e) + // = ( d) * 2^-e + ( r) + // + // or + // 10^m * p2 * 2^e = d + r * 2^e + // + // i.e. + // + // M+ = buffer + p2 * 2^e + // = buffer + 10^-m * (d + r * 2^e) + // = (buffer * 10^m + d) * 10^-m + 10^-m * r * 2^e + // + // and stop as soon as 10^-m * r * 2^e <= delta * 2^e + + assert(p2 > delta); + + int m = 0; + for (;;) + { + // Invariant: + // M+ = buffer * 10^-m + 10^-m * (d[-m-1] / 10 + d[-m-2] / 10^2 + ...) * 2^e + // = buffer * 10^-m + 10^-m * (p2 ) * 2^e + // = buffer * 10^-m + 10^-m * (1/10 * (10 * p2) ) * 2^e + // = buffer * 10^-m + 10^-m * (1/10 * ((10*p2 div 2^-e) * 2^-e + (10*p2 mod 2^-e)) * 2^e + // + assert(p2 <= UINT64_MAX / 10); + p2 *= 10; + const uint64_t d = p2 >> -one.e; // d = (10 * p2) div 2^-e + const uint64_t r = p2 & (one.f - 1); // r = (10 * p2) mod 2^-e + // + // M+ = buffer * 10^-m + 10^-m * (1/10 * (d * 2^-e + r) * 2^e + // = buffer * 10^-m + 10^-m * (1/10 * (d + r * 2^e)) + // = (buffer * 10 + d) * 10^(-m-1) + 10^(-m-1) * r * 2^e + // + assert(d <= 9); + buffer[length++] = static_cast<char>('0' + d); // buffer := buffer * 10 + d + // + // M+ = buffer * 10^(-m-1) + 10^(-m-1) * r * 2^e + // + p2 = r; + m++; + // + // M+ = buffer * 10^-m + 10^-m * p2 * 2^e + // Invariant restored. + + // Check if enough digits have been generated. + // + // 10^-m * p2 * 2^e <= delta * 2^e + // p2 * 2^e <= 10^m * delta * 2^e + // p2 <= 10^m * delta + delta *= 10; + dist *= 10; + if (p2 <= delta) + { + break; + } + } + + // V = buffer * 10^-m, with M- <= V <= M+. + + decimal_exponent -= m; + + // 1 ulp in the decimal representation is now 10^-m. + // Since delta and dist are now scaled by 10^m, we need to do the + // same with ulp in order to keep the units in sync. + // + // 10^m * 10^-m = 1 = 2^-e * 2^e = ten_m * 2^e + // + const uint64_t ten_m = one.f; + grisu2_round(buffer, length, dist, delta, p2, ten_m); + + // By construction this algorithm generates the shortest possible decimal + // number (Loitsch, Theorem 6.2) which rounds back to w. + // For an input number of precision p, at least + // + // N = 1 + ceil(p * log_10(2)) + // + // decimal digits are sufficient to identify all binary floating-point + // numbers (Matula, "In-and-Out conversions"). + // This implies that the algorithm does not produce more than N decimal + // digits. + // + // N = 17 for p = 53 (IEEE double precision) + // N = 9 for p = 24 (IEEE single precision) +} + +/*! +v = buf * 10^decimal_exponent +len is the length of the buffer (number of decimal digits) +The buffer must be large enough, i.e. >= max_digits10. +*/ +inline void grisu2(char* buf, int& len, int& decimal_exponent, + diyfp m_minus, diyfp v, diyfp m_plus) +{ + assert(m_plus.e == m_minus.e); + assert(m_plus.e == v.e); + + // --------(-----------------------+-----------------------)-------- (A) + // m- v m+ + // + // --------------------(-----------+-----------------------)-------- (B) + // m- v m+ + // + // First scale v (and m- and m+) such that the exponent is in the range + // [alpha, gamma]. + + const cached_power cached = get_cached_power_for_binary_exponent(m_plus.e); + + const diyfp c_minus_k(cached.f, cached.e); // = c ~= 10^-k + + // The exponent of the products is = v.e + c_minus_k.e + q and is in the range [alpha,gamma] + const diyfp w = diyfp::mul(v, c_minus_k); + const diyfp w_minus = diyfp::mul(m_minus, c_minus_k); + const diyfp w_plus = diyfp::mul(m_plus, c_minus_k); + + // ----(---+---)---------------(---+---)---------------(---+---)---- + // w- w w+ + // = c*m- = c*v = c*m+ + // + // diyfp::mul rounds its result and c_minus_k is approximated too. w, w- and + // w+ are now off by a small amount. + // In fact: + // + // w - v * 10^k < 1 ulp + // + // To account for this inaccuracy, add resp. subtract 1 ulp. + // + // --------+---[---------------(---+---)---------------]---+-------- + // w- M- w M+ w+ + // + // Now any number in [M-, M+] (bounds included) will round to w when input, + // regardless of how the input rounding algorithm breaks ties. + // + // And digit_gen generates the shortest possible such number in [M-, M+]. + // Note that this does not mean that Grisu2 always generates the shortest + // possible number in the interval (m-, m+). + const diyfp M_minus(w_minus.f + 1, w_minus.e); + const diyfp M_plus (w_plus.f - 1, w_plus.e ); + + decimal_exponent = -cached.k; // = -(-k) = k + + grisu2_digit_gen(buf, len, decimal_exponent, M_minus, w, M_plus); +} + +/*! +v = buf * 10^decimal_exponent +len is the length of the buffer (number of decimal digits) +The buffer must be large enough, i.e. >= max_digits10. +*/ +template <typename FloatType> +void grisu2(char* buf, int& len, int& decimal_exponent, FloatType value) +{ + static_assert(diyfp::kPrecision >= std::numeric_limits<FloatType>::digits + 3, + "internal error: not enough precision"); + + assert(std::isfinite(value)); + assert(value > 0); + + // If the neighbors (and boundaries) of 'value' are always computed for double-precision + // numbers, all float's can be recovered using strtod (and strtof). However, the resulting + // decimal representations are not exactly "short". + // + // The documentation for 'std::to_chars' (https://en.cppreference.com/w/cpp/utility/to_chars) + // says "value is converted to a string as if by std::sprintf in the default ("C") locale" + // and since sprintf promotes float's to double's, I think this is exactly what 'std::to_chars' + // does. + // On the other hand, the documentation for 'std::to_chars' requires that "parsing the + // representation using the corresponding std::from_chars function recovers value exactly". That + // indicates that single precision floating-point numbers should be recovered using + // 'std::strtof'. + // + // NB: If the neighbors are computed for single-precision numbers, there is a single float + // (7.0385307e-26f) which can't be recovered using strtod. The resulting double precision + // value is off by 1 ulp. +#if 0 + const boundaries w = compute_boundaries(static_cast<double>(value)); +#else + const boundaries w = compute_boundaries(value); +#endif + + grisu2(buf, len, decimal_exponent, w.minus, w.w, w.plus); +} + +/*! +@brief appends a decimal representation of e to buf +@return a pointer to the element following the exponent. +@pre -1000 < e < 1000 +*/ +inline char* append_exponent(char* buf, int e) +{ + assert(e > -1000); + assert(e < 1000); + + if (e < 0) + { + e = -e; + *buf++ = '-'; + } + else + { + *buf++ = '+'; + } + + uint32_t k = static_cast<uint32_t>(e); + if (k < 10) + { + // Always print at least two digits in the exponent. + // This is for compatibility with printf("%g"). + *buf++ = '0'; + *buf++ = static_cast<char>('0' + k); + } + else if (k < 100) + { + *buf++ = static_cast<char>('0' + k / 10); + k %= 10; + *buf++ = static_cast<char>('0' + k); + } + else + { + *buf++ = static_cast<char>('0' + k / 100); + k %= 100; + *buf++ = static_cast<char>('0' + k / 10); + k %= 10; + *buf++ = static_cast<char>('0' + k); + } + + return buf; +} + +/*! +@brief prettify v = buf * 10^decimal_exponent + +If v is in the range [10^min_exp, 10^max_exp) it will be printed in fixed-point +notation. Otherwise it will be printed in exponential notation. + +@pre min_exp < 0 +@pre max_exp > 0 +*/ +inline char* format_buffer(char* buf, int len, int decimal_exponent, + int min_exp, int max_exp) +{ + assert(min_exp < 0); + assert(max_exp > 0); + + const int k = len; + const int n = len + decimal_exponent; + + // v = buf * 10^(n-k) + // k is the length of the buffer (number of decimal digits) + // n is the position of the decimal point relative to the start of the buffer. + + if (k <= n and n <= max_exp) + { + // digits[000] + // len <= max_exp + 2 + + std::memset(buf + k, '0', static_cast<size_t>(n - k)); + // Make it look like a floating-point number (#362, #378) + buf[n + 0] = '.'; + buf[n + 1] = '0'; + return buf + (n + 2); + } + + if (0 < n and n <= max_exp) + { + // dig.its + // len <= max_digits10 + 1 + + assert(k > n); + + std::memmove(buf + (n + 1), buf + n, static_cast<size_t>(k - n)); + buf[n] = '.'; + return buf + (k + 1); + } + + if (min_exp < n and n <= 0) + { + // 0.[000]digits + // len <= 2 + (-min_exp - 1) + max_digits10 + + std::memmove(buf + (2 + -n), buf, static_cast<size_t>(k)); + buf[0] = '0'; + buf[1] = '.'; + std::memset(buf + 2, '0', static_cast<size_t>(-n)); + return buf + (2 + (-n) + k); + } + + if (k == 1) + { + // dE+123 + // len <= 1 + 5 + + buf += 1; + } + else + { + // d.igitsE+123 + // len <= max_digits10 + 1 + 5 + + std::memmove(buf + 2, buf + 1, static_cast<size_t>(k - 1)); + buf[1] = '.'; + buf += 1 + k; + } + + *buf++ = 'e'; + return append_exponent(buf, n - 1); +} + +} // namespace dtoa_impl + +/*! +@brief generates a decimal representation of the floating-point number value in [first, last). + +The format of the resulting decimal representation is similar to printf's %g +format. Returns an iterator pointing past-the-end of the decimal representation. + +@note The input number must be finite, i.e. NaN's and Inf's are not supported. +@note The buffer must be large enough. +@note The result is NOT null-terminated. +*/ +template <typename FloatType> +char* to_chars(char* first, char* last, FloatType value) +{ + static_cast<void>(last); // maybe unused - fix warning + assert(std::isfinite(value)); + + // Use signbit(value) instead of (value < 0) since signbit works for -0. + if (std::signbit(value)) + { + value = -value; + *first++ = '-'; + } + + if (value == 0) // +-0 + { + *first++ = '0'; + // Make it look like a floating-point number (#362, #378) + *first++ = '.'; + *first++ = '0'; + return first; + } + + assert(last - first >= std::numeric_limits<FloatType>::max_digits10); + + // Compute v = buffer * 10^decimal_exponent. + // The decimal digits are stored in the buffer, which needs to be interpreted + // as an unsigned decimal integer. + // len is the length of the buffer, i.e. the number of decimal digits. + int len = 0; + int decimal_exponent = 0; + dtoa_impl::grisu2(first, len, decimal_exponent, value); + + assert(len <= std::numeric_limits<FloatType>::max_digits10); + + // Format the buffer like printf("%.*g", prec, value) + constexpr int kMinExp = -4; + // Use digits10 here to increase compatibility with version 2. + constexpr int kMaxExp = std::numeric_limits<FloatType>::digits10; + + assert(last - first >= kMaxExp + 2); + assert(last - first >= 2 + (-kMinExp - 1) + std::numeric_limits<FloatType>::max_digits10); + assert(last - first >= std::numeric_limits<FloatType>::max_digits10 + 6); + + return dtoa_impl::format_buffer(first, len, decimal_exponent, kMinExp, kMaxExp); +} + +} // namespace detail +} // namespace nlohmann + +// #include <nlohmann/detail/macro_scope.hpp> + +// #include <nlohmann/detail/meta.hpp> + +// #include <nlohmann/detail/output/output_adapters.hpp> + +// #include <nlohmann/detail/value_t.hpp> + + +namespace nlohmann +{ +namespace detail +{ +/////////////////// +// serialization // +/////////////////// + +template<typename BasicJsonType> +class serializer +{ + using string_t = typename BasicJsonType::string_t; + using number_float_t = typename BasicJsonType::number_float_t; + using number_integer_t = typename BasicJsonType::number_integer_t; + using number_unsigned_t = typename BasicJsonType::number_unsigned_t; + static constexpr uint8_t UTF8_ACCEPT = 0; + static constexpr uint8_t UTF8_REJECT = 1; + + public: + /*! + @param[in] s output stream to serialize to + @param[in] ichar indentation character to use + */ + serializer(output_adapter_t<char> s, const char ichar) + : o(std::move(s)), loc(std::localeconv()), + thousands_sep(loc->thousands_sep == nullptr ? '\0' : * (loc->thousands_sep)), + decimal_point(loc->decimal_point == nullptr ? '\0' : * (loc->decimal_point)), + indent_char(ichar), indent_string(512, indent_char) + {} + + // delete because of pointer members + serializer(const serializer&) = delete; + serializer& operator=(const serializer&) = delete; + + /*! + @brief internal implementation of the serialization function + + This function is called by the public member function dump and organizes + the serialization internally. The indentation level is propagated as + additional parameter. In case of arrays and objects, the function is + called recursively. + + - strings and object keys are escaped using `escape_string()` + - integer numbers are converted implicitly via `operator<<` + - floating-point numbers are converted to a string using `"%g"` format + + @param[in] val value to serialize + @param[in] pretty_print whether the output shall be pretty-printed + @param[in] indent_step the indent level + @param[in] current_indent the current indent level (only used internally) + */ + void dump(const BasicJsonType& val, const bool pretty_print, + const bool ensure_ascii, + const unsigned int indent_step, + const unsigned int current_indent = 0) + { + switch (val.m_type) + { + case value_t::object: + { + if (val.m_value.object->empty()) + { + o->write_characters("{}", 2); + return; + } + + if (pretty_print) + { + o->write_characters("{\n", 2); + + // variable to hold indentation for recursive calls + const auto new_indent = current_indent + indent_step; + if (JSON_UNLIKELY(indent_string.size() < new_indent)) + { + indent_string.resize(indent_string.size() * 2, ' '); + } + + // first n-1 elements + auto i = val.m_value.object->cbegin(); + for (std::size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i) + { + o->write_characters(indent_string.c_str(), new_indent); + o->write_character('\"'); + dump_escaped(i->first, ensure_ascii); + o->write_characters("\": ", 3); + dump(i->second, true, ensure_ascii, indent_step, new_indent); + o->write_characters(",\n", 2); + } + + // last element + assert(i != val.m_value.object->cend()); + assert(std::next(i) == val.m_value.object->cend()); + o->write_characters(indent_string.c_str(), new_indent); + o->write_character('\"'); + dump_escaped(i->first, ensure_ascii); + o->write_characters("\": ", 3); + dump(i->second, true, ensure_ascii, indent_step, new_indent); + + o->write_character('\n'); + o->write_characters(indent_string.c_str(), current_indent); + o->write_character('}'); + } + else + { + o->write_character('{'); + + // first n-1 elements + auto i = val.m_value.object->cbegin(); + for (std::size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i) + { + o->write_character('\"'); + dump_escaped(i->first, ensure_ascii); + o->write_characters("\":", 2); + dump(i->second, false, ensure_ascii, indent_step, current_indent); + o->write_character(','); + } + + // last element + assert(i != val.m_value.object->cend()); + assert(std::next(i) == val.m_value.object->cend()); + o->write_character('\"'); + dump_escaped(i->first, ensure_ascii); + o->write_characters("\":", 2); + dump(i->second, false, ensure_ascii, indent_step, current_indent); + + o->write_character('}'); + } + + return; + } + + case value_t::array: + { + if (val.m_value.array->empty()) + { + o->write_characters("[]", 2); + return; + } + + if (pretty_print) + { + o->write_characters("[\n", 2); + + // variable to hold indentation for recursive calls + const auto new_indent = current_indent + indent_step; + if (JSON_UNLIKELY(indent_string.size() < new_indent)) + { + indent_string.resize(indent_string.size() * 2, ' '); + } + + // first n-1 elements + for (auto i = val.m_value.array->cbegin(); + i != val.m_value.array->cend() - 1; ++i) + { + o->write_characters(indent_string.c_str(), new_indent); + dump(*i, true, ensure_ascii, indent_step, new_indent); + o->write_characters(",\n", 2); + } + + // last element + assert(not val.m_value.array->empty()); + o->write_characters(indent_string.c_str(), new_indent); + dump(val.m_value.array->back(), true, ensure_ascii, indent_step, new_indent); + + o->write_character('\n'); + o->write_characters(indent_string.c_str(), current_indent); + o->write_character(']'); + } + else + { + o->write_character('['); + + // first n-1 elements + for (auto i = val.m_value.array->cbegin(); + i != val.m_value.array->cend() - 1; ++i) + { + dump(*i, false, ensure_ascii, indent_step, current_indent); + o->write_character(','); + } + + // last element + assert(not val.m_value.array->empty()); + dump(val.m_value.array->back(), false, ensure_ascii, indent_step, current_indent); + + o->write_character(']'); + } + + return; + } + + case value_t::string: + { + o->write_character('\"'); + dump_escaped(*val.m_value.string, ensure_ascii); + o->write_character('\"'); + return; + } + + case value_t::boolean: + { + if (val.m_value.boolean) + { + o->write_characters("true", 4); + } + else + { + o->write_characters("false", 5); + } + return; + } + + case value_t::number_integer: + { + dump_integer(val.m_value.number_integer); + return; + } + + case value_t::number_unsigned: + { + dump_integer(val.m_value.number_unsigned); + return; + } + + case value_t::number_float: + { + dump_float(val.m_value.number_float); + return; + } + + case value_t::discarded: + { + o->write_characters("<discarded>", 11); + return; + } + + case value_t::null: + { + o->write_characters("null", 4); + return; + } + } + } + + private: + /*! + @brief dump escaped string + + Escape a string by replacing certain special characters by a sequence of an + escape character (backslash) and another character and other control + characters by a sequence of "\u" followed by a four-digit hex + representation. The escaped string is written to output stream @a o. + + @param[in] s the string to escape + @param[in] ensure_ascii whether to escape non-ASCII characters with + \uXXXX sequences + + @complexity Linear in the length of string @a s. + */ + void dump_escaped(const string_t& s, const bool ensure_ascii) + { + uint32_t codepoint; + uint8_t state = UTF8_ACCEPT; + std::size_t bytes = 0; // number of bytes written to string_buffer + + for (std::size_t i = 0; i < s.size(); ++i) + { + const auto byte = static_cast<uint8_t>(s[i]); + + switch (decode(state, codepoint, byte)) + { + case UTF8_ACCEPT: // decode found a new code point + { + switch (codepoint) + { + case 0x08: // backspace + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 'b'; + break; + } + + case 0x09: // horizontal tab + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 't'; + break; + } + + case 0x0A: // newline + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 'n'; + break; + } + + case 0x0C: // formfeed + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 'f'; + break; + } + + case 0x0D: // carriage return + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = 'r'; + break; + } + + case 0x22: // quotation mark + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = '\"'; + break; + } + + case 0x5C: // reverse solidus + { + string_buffer[bytes++] = '\\'; + string_buffer[bytes++] = '\\'; + break; + } + + default: + { + // escape control characters (0x00..0x1F) or, if + // ensure_ascii parameter is used, non-ASCII characters + if ((codepoint <= 0x1F) or (ensure_ascii and (codepoint >= 0x7F))) + { + if (codepoint <= 0xFFFF) + { + std::snprintf(string_buffer.data() + bytes, 7, "\\u%04x", + static_cast<uint16_t>(codepoint)); + bytes += 6; + } + else + { + std::snprintf(string_buffer.data() + bytes, 13, "\\u%04x\\u%04x", + static_cast<uint16_t>(0xD7C0 + (codepoint >> 10)), + static_cast<uint16_t>(0xDC00 + (codepoint & 0x3FF))); + bytes += 12; + } + } + else + { + // copy byte to buffer (all previous bytes + // been copied have in default case above) + string_buffer[bytes++] = s[i]; + } + break; + } + } + + // write buffer and reset index; there must be 13 bytes + // left, as this is the maximal number of bytes to be + // written ("\uxxxx\uxxxx\0") for one code point + if (string_buffer.size() - bytes < 13) + { + o->write_characters(string_buffer.data(), bytes); + bytes = 0; + } + break; + } + + case UTF8_REJECT: // decode found invalid UTF-8 byte + { + std::string sn(3, '\0'); + snprintf(&sn[0], sn.size(), "%.2X", byte); + JSON_THROW(type_error::create(316, "invalid UTF-8 byte at index " + std::to_string(i) + ": 0x" + sn)); + } + + default: // decode found yet incomplete multi-byte code point + { + if (not ensure_ascii) + { + // code point will not be escaped - copy byte to buffer + string_buffer[bytes++] = s[i]; + } + break; + } + } + } + + if (JSON_LIKELY(state == UTF8_ACCEPT)) + { + // write buffer + if (bytes > 0) + { + o->write_characters(string_buffer.data(), bytes); + } + } + else + { + // we finish reading, but do not accept: string was incomplete + std::string sn(3, '\0'); + snprintf(&sn[0], sn.size(), "%.2X", static_cast<uint8_t>(s.back())); + JSON_THROW(type_error::create(316, "incomplete UTF-8 string; last byte: 0x" + sn)); + } + } + + /*! + @brief dump an integer + + Dump a given integer to output stream @a o. Works internally with + @a number_buffer. + + @param[in] x integer number (signed or unsigned) to dump + @tparam NumberType either @a number_integer_t or @a number_unsigned_t + */ + template<typename NumberType, detail::enable_if_t< + std::is_same<NumberType, number_unsigned_t>::value or + std::is_same<NumberType, number_integer_t>::value, + int> = 0> + void dump_integer(NumberType x) + { + // special case for "0" + if (x == 0) + { + o->write_character('0'); + return; + } + + const bool is_negative = (x <= 0) and (x != 0); // see issue #755 + std::size_t i = 0; + + while (x != 0) + { + // spare 1 byte for '\0' + assert(i < number_buffer.size() - 1); + + const auto digit = std::labs(static_cast<long>(x % 10)); + number_buffer[i++] = static_cast<char>('0' + digit); + x /= 10; + } + + if (is_negative) + { + // make sure there is capacity for the '-' + assert(i < number_buffer.size() - 2); + number_buffer[i++] = '-'; + } + + std::reverse(number_buffer.begin(), number_buffer.begin() + i); + o->write_characters(number_buffer.data(), i); + } + + /*! + @brief dump a floating-point number + + Dump a given floating-point number to output stream @a o. Works internally + with @a number_buffer. + + @param[in] x floating-point number to dump + */ + void dump_float(number_float_t x) + { + // NaN / inf + if (not std::isfinite(x)) + { + o->write_characters("null", 4); + return; + } + + // If number_float_t is an IEEE-754 single or double precision number, + // use the Grisu2 algorithm to produce short numbers which are + // guaranteed to round-trip, using strtof and strtod, resp. + // + // NB: The test below works if <long double> == <double>. + static constexpr bool is_ieee_single_or_double + = (std::numeric_limits<number_float_t>::is_iec559 and std::numeric_limits<number_float_t>::digits == 24 and std::numeric_limits<number_float_t>::max_exponent == 128) or + (std::numeric_limits<number_float_t>::is_iec559 and std::numeric_limits<number_float_t>::digits == 53 and std::numeric_limits<number_float_t>::max_exponent == 1024); + + dump_float(x, std::integral_constant<bool, is_ieee_single_or_double>()); + } + + void dump_float(number_float_t x, std::true_type /*is_ieee_single_or_double*/) + { + char* begin = number_buffer.data(); + char* end = ::nlohmann::detail::to_chars(begin, begin + number_buffer.size(), x); + + o->write_characters(begin, static_cast<size_t>(end - begin)); + } + + void dump_float(number_float_t x, std::false_type /*is_ieee_single_or_double*/) + { + // get number of digits for a float -> text -> float round-trip + static constexpr auto d = std::numeric_limits<number_float_t>::max_digits10; + + // the actual conversion + std::ptrdiff_t len = snprintf(number_buffer.data(), number_buffer.size(), "%.*g", d, x); + + // negative value indicates an error + assert(len > 0); + // check if buffer was large enough + assert(static_cast<std::size_t>(len) < number_buffer.size()); + + // erase thousands separator + if (thousands_sep != '\0') + { + const auto end = std::remove(number_buffer.begin(), + number_buffer.begin() + len, thousands_sep); + std::fill(end, number_buffer.end(), '\0'); + assert((end - number_buffer.begin()) <= len); + len = (end - number_buffer.begin()); + } + + // convert decimal point to '.' + if (decimal_point != '\0' and decimal_point != '.') + { + const auto dec_pos = std::find(number_buffer.begin(), number_buffer.end(), decimal_point); + if (dec_pos != number_buffer.end()) + { + *dec_pos = '.'; + } + } + + o->write_characters(number_buffer.data(), static_cast<std::size_t>(len)); + + // determine if need to append ".0" + const bool value_is_int_like = + std::none_of(number_buffer.begin(), number_buffer.begin() + len + 1, + [](char c) + { + return (c == '.' or c == 'e'); + }); + + if (value_is_int_like) + { + o->write_characters(".0", 2); + } + } + + /*! + @brief check whether a string is UTF-8 encoded + + The function checks each byte of a string whether it is UTF-8 encoded. The + result of the check is stored in the @a state parameter. The function must + be called initially with state 0 (accept). State 1 means the string must + be rejected, because the current byte is not allowed. If the string is + completely processed, but the state is non-zero, the string ended + prematurely; that is, the last byte indicated more bytes should have + followed. + + @param[in,out] state the state of the decoding + @param[in,out] codep codepoint (valid only if resulting state is UTF8_ACCEPT) + @param[in] byte next byte to decode + @return new state + + @note The function has been edited: a std::array is used. + + @copyright Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de> + @sa http://bjoern.hoehrmann.de/utf-8/decoder/dfa/ + */ + static uint8_t decode(uint8_t& state, uint32_t& codep, const uint8_t byte) noexcept + { + static const std::array<uint8_t, 400> utf8d = + { + { + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 00..1F + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 20..3F + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 40..5F + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 60..7F + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, // 80..9F + 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, // A0..BF + 8, 8, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, // C0..DF + 0xA, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x3, 0x4, 0x3, 0x3, // E0..EF + 0xB, 0x6, 0x6, 0x6, 0x5, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, 0x8, // F0..FF + 0x0, 0x1, 0x2, 0x3, 0x5, 0x8, 0x7, 0x1, 0x1, 0x1, 0x4, 0x6, 0x1, 0x1, 0x1, 0x1, // s0..s0 + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, // s1..s2 + 1, 2, 1, 1, 1, 1, 1, 2, 1, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 1, 1, 1, 1, 1, 1, 1, 1, // s3..s4 + 1, 2, 1, 1, 1, 1, 1, 1, 1, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 3, 1, 3, 1, 1, 1, 1, 1, 1, // s5..s6 + 1, 3, 1, 1, 1, 1, 1, 3, 1, 3, 1, 1, 1, 1, 1, 1, 1, 3, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 // s7..s8 + } + }; + + const uint8_t type = utf8d[byte]; + + codep = (state != UTF8_ACCEPT) + ? (byte & 0x3fu) | (codep << 6) + : static_cast<uint32_t>(0xff >> type) & (byte); + + state = utf8d[256u + state * 16u + type]; + return state; + } + + private: + /// the output of the serializer + output_adapter_t<char> o = nullptr; + + /// a (hopefully) large enough character buffer + std::array<char, 64> number_buffer{{}}; + + /// the locale + const std::lconv* loc = nullptr; + /// the locale's thousand separator character + const char thousands_sep = '\0'; + /// the locale's decimal point character + const char decimal_point = '\0'; + + /// string buffer + std::array<char, 512> string_buffer{{}}; + + /// the indentation character + const char indent_char; + /// the indentation string + string_t indent_string; +}; +} +} + +// #include <nlohmann/detail/json_ref.hpp> + + +#include <initializer_list> +#include <utility> + +namespace nlohmann +{ +namespace detail +{ +template<typename BasicJsonType> +class json_ref +{ + public: + using value_type = BasicJsonType; + + json_ref(value_type&& value) + : owned_value(std::move(value)), value_ref(&owned_value), is_rvalue(true) + {} + + json_ref(const value_type& value) + : value_ref(const_cast<value_type*>(&value)), is_rvalue(false) + {} + + json_ref(std::initializer_list<json_ref> init) + : owned_value(init), value_ref(&owned_value), is_rvalue(true) + {} + + template<class... Args> + json_ref(Args&& ... args) + : owned_value(std::forward<Args>(args)...), value_ref(&owned_value), is_rvalue(true) + {} + + // class should be movable only + json_ref(json_ref&&) = default; + json_ref(const json_ref&) = delete; + json_ref& operator=(const json_ref&) = delete; + + value_type moved_or_copied() const + { + if (is_rvalue) + { + return std::move(*value_ref); + } + return *value_ref; + } + + value_type const& operator*() const + { + return *static_cast<value_type const*>(value_ref); + } + + value_type const* operator->() const + { + return static_cast<value_type const*>(value_ref); + } + + private: + mutable value_type owned_value = nullptr; + value_type* value_ref = nullptr; + const bool is_rvalue; +}; +} +} + +// #include <nlohmann/detail/json_pointer.hpp> + + +#include <cassert> // assert +#include <numeric> // accumulate +#include <string> // string +#include <vector> // vector + +// #include <nlohmann/detail/macro_scope.hpp> + +// #include <nlohmann/detail/exceptions.hpp> + +// #include <nlohmann/detail/value_t.hpp> + + +namespace nlohmann +{ +template<typename BasicJsonType> +class json_pointer +{ + // allow basic_json to access private members + NLOHMANN_BASIC_JSON_TPL_DECLARATION + friend class basic_json; + + public: + /*! + @brief create JSON pointer + + Create a JSON pointer according to the syntax described in + [Section 3 of RFC6901](https://tools.ietf.org/html/rfc6901#section-3). + + @param[in] s string representing the JSON pointer; if omitted, the empty + string is assumed which references the whole JSON value + + @throw parse_error.107 if the given JSON pointer @a s is nonempty and does + not begin with a slash (`/`); see example below + + @throw parse_error.108 if a tilde (`~`) in the given JSON pointer @a s is + not followed by `0` (representing `~`) or `1` (representing `/`); see + example below + + @liveexample{The example shows the construction several valid JSON pointers + as well as the exceptional behavior.,json_pointer} + + @since version 2.0.0 + */ + explicit json_pointer(const std::string& s = "") + : reference_tokens(split(s)) + {} + + /*! + @brief return a string representation of the JSON pointer + + @invariant For each JSON pointer `ptr`, it holds: + @code {.cpp} + ptr == json_pointer(ptr.to_string()); + @endcode + + @return a string representation of the JSON pointer + + @liveexample{The example shows the result of `to_string`., + json_pointer__to_string} + + @since version 2.0.0 + */ + std::string to_string() const noexcept + { + return std::accumulate(reference_tokens.begin(), reference_tokens.end(), + std::string{}, + [](const std::string & a, const std::string & b) + { + return a + "/" + escape(b); + }); + } + + /// @copydoc to_string() + operator std::string() const + { + return to_string(); + } + + /*! + @param[in] s reference token to be converted into an array index + + @return integer representation of @a s + + @throw out_of_range.404 if string @a s could not be converted to an integer + */ + static int array_index(const std::string& s) + { + std::size_t processed_chars = 0; + const int res = std::stoi(s, &processed_chars); + + // check if the string was completely read + if (JSON_UNLIKELY(processed_chars != s.size())) + { + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + s + "'")); + } + + return res; + } + + private: + /*! + @brief remove and return last reference pointer + @throw out_of_range.405 if JSON pointer has no parent + */ + std::string pop_back() + { + if (JSON_UNLIKELY(is_root())) + { + JSON_THROW(detail::out_of_range::create(405, "JSON pointer has no parent")); + } + + auto last = reference_tokens.back(); + reference_tokens.pop_back(); + return last; + } + + /// return whether pointer points to the root document + bool is_root() const + { + return reference_tokens.empty(); + } + + json_pointer top() const + { + if (JSON_UNLIKELY(is_root())) + { + JSON_THROW(detail::out_of_range::create(405, "JSON pointer has no parent")); + } + + json_pointer result = *this; + result.reference_tokens = {reference_tokens[0]}; + return result; + } + + /*! + @brief create and return a reference to the pointed to value + + @complexity Linear in the number of reference tokens. + + @throw parse_error.109 if array index is not a number + @throw type_error.313 if value cannot be unflattened + */ + BasicJsonType& get_and_create(BasicJsonType& j) const + { + using size_type = typename BasicJsonType::size_type; + auto result = &j; + + // in case no reference tokens exist, return a reference to the JSON value + // j which will be overwritten by a primitive value + for (const auto& reference_token : reference_tokens) + { + switch (result->m_type) + { + case detail::value_t::null: + { + if (reference_token == "0") + { + // start a new array if reference token is 0 + result = &result->operator[](0); + } + else + { + // start a new object otherwise + result = &result->operator[](reference_token); + } + break; + } + + case detail::value_t::object: + { + // create an entry in the object + result = &result->operator[](reference_token); + break; + } + + case detail::value_t::array: + { + // create an entry in the array + JSON_TRY + { + result = &result->operator[](static_cast<size_type>(array_index(reference_token))); + } + JSON_CATCH(std::invalid_argument&) + { + JSON_THROW(detail::parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); + } + break; + } + + /* + The following code is only reached if there exists a reference + token _and_ the current value is primitive. In this case, we have + an error situation, because primitive values may only occur as + single value; that is, with an empty list of reference tokens. + */ + default: + JSON_THROW(detail::type_error::create(313, "invalid value to unflatten")); + } + } + + return *result; + } + + /*! + @brief return a reference to the pointed to value + + @note This version does not throw if a value is not present, but tries to + create nested values instead. For instance, calling this function + with pointer `"/this/that"` on a null value is equivalent to calling + `operator[]("this").operator[]("that")` on that value, effectively + changing the null value to an object. + + @param[in] ptr a JSON value + + @return reference to the JSON value pointed to by the JSON pointer + + @complexity Linear in the length of the JSON pointer. + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.404 if the JSON pointer can not be resolved + */ + BasicJsonType& get_unchecked(BasicJsonType* ptr) const + { + using size_type = typename BasicJsonType::size_type; + for (const auto& reference_token : reference_tokens) + { + // convert null values to arrays or objects before continuing + if (ptr->m_type == detail::value_t::null) + { + // check if reference token is a number + const bool nums = + std::all_of(reference_token.begin(), reference_token.end(), + [](const char x) + { + return (x >= '0' and x <= '9'); + }); + + // change value to array for numbers or "-" or to object otherwise + *ptr = (nums or reference_token == "-") + ? detail::value_t::array + : detail::value_t::object; + } + + switch (ptr->m_type) + { + case detail::value_t::object: + { + // use unchecked object access + ptr = &ptr->operator[](reference_token); + break; + } + + case detail::value_t::array: + { + // error condition (cf. RFC 6901, Sect. 4) + if (JSON_UNLIKELY(reference_token.size() > 1 and reference_token[0] == '0')) + { + JSON_THROW(detail::parse_error::create(106, 0, + "array index '" + reference_token + + "' must not begin with '0'")); + } + + if (reference_token == "-") + { + // explicitly treat "-" as index beyond the end + ptr = &ptr->operator[](ptr->m_value.array->size()); + } + else + { + // convert array index to number; unchecked access + JSON_TRY + { + ptr = &ptr->operator[]( + static_cast<size_type>(array_index(reference_token))); + } + JSON_CATCH(std::invalid_argument&) + { + JSON_THROW(detail::parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); + } + } + break; + } + + default: + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); + } + } + + return *ptr; + } + + /*! + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.402 if the array index '-' is used + @throw out_of_range.404 if the JSON pointer can not be resolved + */ + BasicJsonType& get_checked(BasicJsonType* ptr) const + { + using size_type = typename BasicJsonType::size_type; + for (const auto& reference_token : reference_tokens) + { + switch (ptr->m_type) + { + case detail::value_t::object: + { + // note: at performs range check + ptr = &ptr->at(reference_token); + break; + } + + case detail::value_t::array: + { + if (JSON_UNLIKELY(reference_token == "-")) + { + // "-" always fails the range check + JSON_THROW(detail::out_of_range::create(402, + "array index '-' (" + std::to_string(ptr->m_value.array->size()) + + ") is out of range")); + } + + // error condition (cf. RFC 6901, Sect. 4) + if (JSON_UNLIKELY(reference_token.size() > 1 and reference_token[0] == '0')) + { + JSON_THROW(detail::parse_error::create(106, 0, + "array index '" + reference_token + + "' must not begin with '0'")); + } + + // note: at performs range check + JSON_TRY + { + ptr = &ptr->at(static_cast<size_type>(array_index(reference_token))); + } + JSON_CATCH(std::invalid_argument&) + { + JSON_THROW(detail::parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); + } + break; + } + + default: + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); + } + } + + return *ptr; + } + + /*! + @brief return a const reference to the pointed to value + + @param[in] ptr a JSON value + + @return const reference to the JSON value pointed to by the JSON + pointer + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.402 if the array index '-' is used + @throw out_of_range.404 if the JSON pointer can not be resolved + */ + const BasicJsonType& get_unchecked(const BasicJsonType* ptr) const + { + using size_type = typename BasicJsonType::size_type; + for (const auto& reference_token : reference_tokens) + { + switch (ptr->m_type) + { + case detail::value_t::object: + { + // use unchecked object access + ptr = &ptr->operator[](reference_token); + break; + } + + case detail::value_t::array: + { + if (JSON_UNLIKELY(reference_token == "-")) + { + // "-" cannot be used for const access + JSON_THROW(detail::out_of_range::create(402, + "array index '-' (" + std::to_string(ptr->m_value.array->size()) + + ") is out of range")); + } + + // error condition (cf. RFC 6901, Sect. 4) + if (JSON_UNLIKELY(reference_token.size() > 1 and reference_token[0] == '0')) + { + JSON_THROW(detail::parse_error::create(106, 0, + "array index '" + reference_token + + "' must not begin with '0'")); + } + + // use unchecked array access + JSON_TRY + { + ptr = &ptr->operator[]( + static_cast<size_type>(array_index(reference_token))); + } + JSON_CATCH(std::invalid_argument&) + { + JSON_THROW(detail::parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); + } + break; + } + + default: + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); + } + } + + return *ptr; + } + + /*! + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.402 if the array index '-' is used + @throw out_of_range.404 if the JSON pointer can not be resolved + */ + const BasicJsonType& get_checked(const BasicJsonType* ptr) const + { + using size_type = typename BasicJsonType::size_type; + for (const auto& reference_token : reference_tokens) + { + switch (ptr->m_type) + { + case detail::value_t::object: + { + // note: at performs range check + ptr = &ptr->at(reference_token); + break; + } + + case detail::value_t::array: + { + if (JSON_UNLIKELY(reference_token == "-")) + { + // "-" always fails the range check + JSON_THROW(detail::out_of_range::create(402, + "array index '-' (" + std::to_string(ptr->m_value.array->size()) + + ") is out of range")); + } + + // error condition (cf. RFC 6901, Sect. 4) + if (JSON_UNLIKELY(reference_token.size() > 1 and reference_token[0] == '0')) + { + JSON_THROW(detail::parse_error::create(106, 0, + "array index '" + reference_token + + "' must not begin with '0'")); + } + + // note: at performs range check + JSON_TRY + { + ptr = &ptr->at(static_cast<size_type>(array_index(reference_token))); + } + JSON_CATCH(std::invalid_argument&) + { + JSON_THROW(detail::parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); + } + break; + } + + default: + JSON_THROW(detail::out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); + } + } + + return *ptr; + } + + /*! + @brief split the string input to reference tokens + + @note This function is only called by the json_pointer constructor. + All exceptions below are documented there. + + @throw parse_error.107 if the pointer is not empty or begins with '/' + @throw parse_error.108 if character '~' is not followed by '0' or '1' + */ + static std::vector<std::string> split(const std::string& reference_string) + { + std::vector<std::string> result; + + // special case: empty reference string -> no reference tokens + if (reference_string.empty()) + { + return result; + } + + // check if nonempty reference string begins with slash + if (JSON_UNLIKELY(reference_string[0] != '/')) + { + JSON_THROW(detail::parse_error::create(107, 1, + "JSON pointer must be empty or begin with '/' - was: '" + + reference_string + "'")); + } + + // extract the reference tokens: + // - slash: position of the last read slash (or end of string) + // - start: position after the previous slash + for ( + // search for the first slash after the first character + std::size_t slash = reference_string.find_first_of('/', 1), + // set the beginning of the first reference token + start = 1; + // we can stop if start == string::npos+1 = 0 + start != 0; + // set the beginning of the next reference token + // (will eventually be 0 if slash == std::string::npos) + start = slash + 1, + // find next slash + slash = reference_string.find_first_of('/', start)) + { + // use the text between the beginning of the reference token + // (start) and the last slash (slash). + auto reference_token = reference_string.substr(start, slash - start); + + // check reference tokens are properly escaped + for (std::size_t pos = reference_token.find_first_of('~'); + pos != std::string::npos; + pos = reference_token.find_first_of('~', pos + 1)) + { + assert(reference_token[pos] == '~'); + + // ~ must be followed by 0 or 1 + if (JSON_UNLIKELY(pos == reference_token.size() - 1 or + (reference_token[pos + 1] != '0' and + reference_token[pos + 1] != '1'))) + { + JSON_THROW(detail::parse_error::create(108, 0, "escape character '~' must be followed with '0' or '1'")); + } + } + + // finally, store the reference token + unescape(reference_token); + result.push_back(reference_token); + } + + return result; + } + + /*! + @brief replace all occurrences of a substring by another string + + @param[in,out] s the string to manipulate; changed so that all + occurrences of @a f are replaced with @a t + @param[in] f the substring to replace with @a t + @param[in] t the string to replace @a f + + @pre The search string @a f must not be empty. **This precondition is + enforced with an assertion.** + + @since version 2.0.0 + */ + static void replace_substring(std::string& s, const std::string& f, + const std::string& t) + { + assert(not f.empty()); + for (auto pos = s.find(f); // find first occurrence of f + pos != std::string::npos; // make sure f was found + s.replace(pos, f.size(), t), // replace with t, and + pos = s.find(f, pos + t.size())) // find next occurrence of f + {} + } + + /// escape "~"" to "~0" and "/" to "~1" + static std::string escape(std::string s) + { + replace_substring(s, "~", "~0"); + replace_substring(s, "/", "~1"); + return s; + } + + /// unescape "~1" to tilde and "~0" to slash (order is important!) + static void unescape(std::string& s) + { + replace_substring(s, "~1", "/"); + replace_substring(s, "~0", "~"); + } + + /*! + @param[in] reference_string the reference string to the current value + @param[in] value the value to consider + @param[in,out] result the result object to insert values to + + @note Empty objects or arrays are flattened to `null`. + */ + static void flatten(const std::string& reference_string, + const BasicJsonType& value, + BasicJsonType& result) + { + switch (value.m_type) + { + case detail::value_t::array: + { + if (value.m_value.array->empty()) + { + // flatten empty array as null + result[reference_string] = nullptr; + } + else + { + // iterate array and use index as reference string + for (std::size_t i = 0; i < value.m_value.array->size(); ++i) + { + flatten(reference_string + "/" + std::to_string(i), + value.m_value.array->operator[](i), result); + } + } + break; + } + + case detail::value_t::object: + { + if (value.m_value.object->empty()) + { + // flatten empty object as null + result[reference_string] = nullptr; + } + else + { + // iterate object and use keys as reference string + for (const auto& element : *value.m_value.object) + { + flatten(reference_string + "/" + escape(element.first), element.second, result); + } + } + break; + } + + default: + { + // add primitive value with its reference string + result[reference_string] = value; + break; + } + } + } + + /*! + @param[in] value flattened JSON + + @return unflattened JSON + + @throw parse_error.109 if array index is not a number + @throw type_error.314 if value is not an object + @throw type_error.315 if object values are not primitive + @throw type_error.313 if value cannot be unflattened + */ + static BasicJsonType + unflatten(const BasicJsonType& value) + { + if (JSON_UNLIKELY(not value.is_object())) + { + JSON_THROW(detail::type_error::create(314, "only objects can be unflattened")); + } + + BasicJsonType result; + + // iterate the JSON object values + for (const auto& element : *value.m_value.object) + { + if (JSON_UNLIKELY(not element.second.is_primitive())) + { + JSON_THROW(detail::type_error::create(315, "values in object must be primitive")); + } + + // assign value to reference pointed to by JSON pointer; Note that if + // the JSON pointer is "" (i.e., points to the whole value), function + // get_and_create returns a reference to result itself. An assignment + // will then create a primitive value. + json_pointer(element.first).get_and_create(result) = element.second; + } + + return result; + } + + friend bool operator==(json_pointer const& lhs, + json_pointer const& rhs) noexcept + { + return (lhs.reference_tokens == rhs.reference_tokens); + } + + friend bool operator!=(json_pointer const& lhs, + json_pointer const& rhs) noexcept + { + return not (lhs == rhs); + } + + /// the reference tokens + std::vector<std::string> reference_tokens; +}; +} + +// #include <nlohmann/adl_serializer.hpp> + + +#include <utility> + +// #include <nlohmann/detail/conversions/from_json.hpp> + +// #include <nlohmann/detail/conversions/to_json.hpp> + + +namespace nlohmann +{ +template<typename, typename> +struct adl_serializer +{ + /*! + @brief convert a JSON value to any value type + + This function is usually called by the `get()` function of the + @ref basic_json class (either explicit or via conversion operators). + + @param[in] j JSON value to read from + @param[in,out] val value to write to + */ + template<typename BasicJsonType, typename ValueType> + static void from_json(BasicJsonType&& j, ValueType& val) noexcept( + noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val))) + { + ::nlohmann::from_json(std::forward<BasicJsonType>(j), val); + } + + /*! + @brief convert any value type to a JSON value + + This function is usually called by the constructors of the @ref basic_json + class. + + @param[in,out] j JSON value to write to + @param[in] val value to read from + */ + template<typename BasicJsonType, typename ValueType> + static void to_json(BasicJsonType& j, ValueType&& val) noexcept( + noexcept(::nlohmann::to_json(j, std::forward<ValueType>(val)))) + { + ::nlohmann::to_json(j, std::forward<ValueType>(val)); + } +}; +} + + +/*! +@brief namespace for Niels Lohmann +@see https://github.com/nlohmann +@since version 1.0.0 +*/ +namespace nlohmann +{ + +/*! +@brief a class to store JSON values + +@tparam ObjectType type for JSON objects (`std::map` by default; will be used +in @ref object_t) +@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used +in @ref array_t) +@tparam StringType type for JSON strings and object keys (`std::string` by +default; will be used in @ref string_t) +@tparam BooleanType type for JSON booleans (`bool` by default; will be used +in @ref boolean_t) +@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by +default; will be used in @ref number_integer_t) +@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c +`uint64_t` by default; will be used in @ref number_unsigned_t) +@tparam NumberFloatType type for JSON floating-point numbers (`double` by +default; will be used in @ref number_float_t) +@tparam AllocatorType type of the allocator to use (`std::allocator` by +default) +@tparam JSONSerializer the serializer to resolve internal calls to `to_json()` +and `from_json()` (@ref adl_serializer by default) + +@requirement The class satisfies the following concept requirements: +- Basic + - [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible): + JSON values can be default constructed. The result will be a JSON null + value. + - [MoveConstructible](https://en.cppreference.com/w/cpp/named_req/MoveConstructible): + A JSON value can be constructed from an rvalue argument. + - [CopyConstructible](https://en.cppreference.com/w/cpp/named_req/CopyConstructible): + A JSON value can be copy-constructed from an lvalue expression. + - [MoveAssignable](https://en.cppreference.com/w/cpp/named_req/MoveAssignable): + A JSON value van be assigned from an rvalue argument. + - [CopyAssignable](https://en.cppreference.com/w/cpp/named_req/CopyAssignable): + A JSON value can be copy-assigned from an lvalue expression. + - [Destructible](https://en.cppreference.com/w/cpp/named_req/Destructible): + JSON values can be destructed. +- Layout + - [StandardLayoutType](https://en.cppreference.com/w/cpp/named_req/StandardLayoutType): + JSON values have + [standard layout](https://en.cppreference.com/w/cpp/language/data_members#Standard_layout): + All non-static data members are private and standard layout types, the + class has no virtual functions or (virtual) base classes. +- Library-wide + - [EqualityComparable](https://en.cppreference.com/w/cpp/named_req/EqualityComparable): + JSON values can be compared with `==`, see @ref + operator==(const_reference,const_reference). + - [LessThanComparable](https://en.cppreference.com/w/cpp/named_req/LessThanComparable): + JSON values can be compared with `<`, see @ref + operator<(const_reference,const_reference). + - [Swappable](https://en.cppreference.com/w/cpp/named_req/Swappable): + Any JSON lvalue or rvalue of can be swapped with any lvalue or rvalue of + other compatible types, using unqualified function call @ref swap(). + - [NullablePointer](https://en.cppreference.com/w/cpp/named_req/NullablePointer): + JSON values can be compared against `std::nullptr_t` objects which are used + to model the `null` value. +- Container + - [Container](https://en.cppreference.com/w/cpp/named_req/Container): + JSON values can be used like STL containers and provide iterator access. + - [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer); + JSON values can be used like STL containers and provide reverse iterator + access. + +@invariant The member variables @a m_value and @a m_type have the following +relationship: +- If `m_type == value_t::object`, then `m_value.object != nullptr`. +- If `m_type == value_t::array`, then `m_value.array != nullptr`. +- If `m_type == value_t::string`, then `m_value.string != nullptr`. +The invariants are checked by member function assert_invariant(). + +@internal +@note ObjectType trick from http://stackoverflow.com/a/9860911 +@endinternal + +@see [RFC 7159: The JavaScript Object Notation (JSON) Data Interchange +Format](http://rfc7159.net/rfc7159) + +@since version 1.0.0 + +@nosubgrouping +*/ +NLOHMANN_BASIC_JSON_TPL_DECLARATION +class basic_json +{ + private: + template<detail::value_t> friend struct detail::external_constructor; + friend ::nlohmann::json_pointer<basic_json>; + friend ::nlohmann::detail::parser<basic_json>; + friend ::nlohmann::detail::serializer<basic_json>; + template<typename BasicJsonType> + friend class ::nlohmann::detail::iter_impl; + template<typename BasicJsonType, typename CharType> + friend class ::nlohmann::detail::binary_writer; + template<typename BasicJsonType> + friend class ::nlohmann::detail::binary_reader; + template<typename BasicJsonType> + friend class ::nlohmann::detail::json_sax_dom_parser; + template<typename BasicJsonType> + friend class ::nlohmann::detail::json_sax_dom_callback_parser; + + /// workaround type for MSVC + using basic_json_t = NLOHMANN_BASIC_JSON_TPL; + + // convenience aliases for types residing in namespace detail; + using lexer = ::nlohmann::detail::lexer<basic_json>; + using parser = ::nlohmann::detail::parser<basic_json>; + + using primitive_iterator_t = ::nlohmann::detail::primitive_iterator_t; + template<typename BasicJsonType> + using internal_iterator = ::nlohmann::detail::internal_iterator<BasicJsonType>; + template<typename BasicJsonType> + using iter_impl = ::nlohmann::detail::iter_impl<BasicJsonType>; + template<typename Iterator> + using iteration_proxy = ::nlohmann::detail::iteration_proxy<Iterator>; + template<typename Base> using json_reverse_iterator = ::nlohmann::detail::json_reverse_iterator<Base>; + + template<typename CharType> + using output_adapter_t = ::nlohmann::detail::output_adapter_t<CharType>; + + using binary_reader = ::nlohmann::detail::binary_reader<basic_json>; + template<typename CharType> using binary_writer = ::nlohmann::detail::binary_writer<basic_json, CharType>; + + using serializer = ::nlohmann::detail::serializer<basic_json>; + + public: + using value_t = detail::value_t; + /// @copydoc nlohmann::json_pointer + using json_pointer = ::nlohmann::json_pointer<basic_json>; + template<typename T, typename SFINAE> + using json_serializer = JSONSerializer<T, SFINAE>; + /// helper type for initializer lists of basic_json values + using initializer_list_t = std::initializer_list<detail::json_ref<basic_json>>; + + using input_format_t = detail::input_format_t; + + //////////////// + // exceptions // + //////////////// + + /// @name exceptions + /// Classes to implement user-defined exceptions. + /// @{ + + /// @copydoc detail::exception + using exception = detail::exception; + /// @copydoc detail::parse_error + using parse_error = detail::parse_error; + /// @copydoc detail::invalid_iterator + using invalid_iterator = detail::invalid_iterator; + /// @copydoc detail::type_error + using type_error = detail::type_error; + /// @copydoc detail::out_of_range + using out_of_range = detail::out_of_range; + /// @copydoc detail::other_error + using other_error = detail::other_error; + + /// @} + + + ///////////////////// + // container types // + ///////////////////// + + /// @name container types + /// The canonic container types to use @ref basic_json like any other STL + /// container. + /// @{ + + /// the type of elements in a basic_json container + using value_type = basic_json; + + /// the type of an element reference + using reference = value_type&; + /// the type of an element const reference + using const_reference = const value_type&; + + /// a type to represent differences between iterators + using difference_type = std::ptrdiff_t; + /// a type to represent container sizes + using size_type = std::size_t; + + /// the allocator type + using allocator_type = AllocatorType<basic_json>; + + /// the type of an element pointer + using pointer = typename std::allocator_traits<allocator_type>::pointer; + /// the type of an element const pointer + using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer; + + /// an iterator for a basic_json container + using iterator = iter_impl<basic_json>; + /// a const iterator for a basic_json container + using const_iterator = iter_impl<const basic_json>; + /// a reverse iterator for a basic_json container + using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>; + /// a const reverse iterator for a basic_json container + using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>; + + /// @} + + + /*! + @brief returns the allocator associated with the container + */ + static allocator_type get_allocator() + { + return allocator_type(); + } + + /*! + @brief returns version information on the library + + This function returns a JSON object with information about the library, + including the version number and information on the platform and compiler. + + @return JSON object holding version information + key | description + ----------- | --------------- + `compiler` | Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version). + `copyright` | The copyright line for the library as string. + `name` | The name of the library as string. + `platform` | The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`. + `url` | The URL of the project as string. + `version` | The version of the library. It is an object with the following keys: `major`, `minor`, and `patch` as defined by [Semantic Versioning](http://semver.org), and `string` (the version string). + + @liveexample{The following code shows an example output of the `meta()` + function.,meta} + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @complexity Constant. + + @since 2.1.0 + */ + static basic_json meta() + { + basic_json result; + + result["copyright"] = "(C) 2013-2017 Niels Lohmann"; + result["name"] = "JSON for Modern C++"; + result["url"] = "https://github.com/nlohmann/json"; + result["version"]["string"] = + std::to_string(NLOHMANN_JSON_VERSION_MAJOR) + "." + + std::to_string(NLOHMANN_JSON_VERSION_MINOR) + "." + + std::to_string(NLOHMANN_JSON_VERSION_PATCH); + result["version"]["major"] = NLOHMANN_JSON_VERSION_MAJOR; + result["version"]["minor"] = NLOHMANN_JSON_VERSION_MINOR; + result["version"]["patch"] = NLOHMANN_JSON_VERSION_PATCH; + +#ifdef _WIN32 + result["platform"] = "win32"; +#elif defined __linux__ + result["platform"] = "linux"; +#elif defined __APPLE__ + result["platform"] = "apple"; +#elif defined __unix__ + result["platform"] = "unix"; +#else + result["platform"] = "unknown"; +#endif + +#if defined(__ICC) || defined(__INTEL_COMPILER) + result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}}; +#elif defined(__clang__) + result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}}; +#elif defined(__GNUC__) || defined(__GNUG__) + result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}}; +#elif defined(__HP_cc) || defined(__HP_aCC) + result["compiler"] = "hp" +#elif defined(__IBMCPP__) + result["compiler"] = {{"family", "ilecpp"}, {"version", __IBMCPP__}}; +#elif defined(_MSC_VER) + result["compiler"] = {{"family", "msvc"}, {"version", _MSC_VER}}; +#elif defined(__PGI) + result["compiler"] = {{"family", "pgcpp"}, {"version", __PGI}}; +#elif defined(__SUNPRO_CC) + result["compiler"] = {{"family", "sunpro"}, {"version", __SUNPRO_CC}}; +#else + result["compiler"] = {{"family", "unknown"}, {"version", "unknown"}}; +#endif + +#ifdef __cplusplus + result["compiler"]["c++"] = std::to_string(__cplusplus); +#else + result["compiler"]["c++"] = "unknown"; +#endif + return result; + } + + + /////////////////////////// + // JSON value data types // + /////////////////////////// + + /// @name JSON value data types + /// The data types to store a JSON value. These types are derived from + /// the template arguments passed to class @ref basic_json. + /// @{ + +#if defined(JSON_HAS_CPP_14) + // Use transparent comparator if possible, combined with perfect forwarding + // on find() and count() calls prevents unnecessary string construction. + using object_comparator_t = std::less<>; +#else + using object_comparator_t = std::less<StringType>; +#endif + + /*! + @brief a type for an object + + [RFC 7159](http://rfc7159.net/rfc7159) describes JSON objects as follows: + > An object is an unordered collection of zero or more name/value pairs, + > where a name is a string and a value is a string, number, boolean, null, + > object, or array. + + To store objects in C++, a type is defined by the template parameters + described below. + + @tparam ObjectType the container to store objects (e.g., `std::map` or + `std::unordered_map`) + @tparam StringType the type of the keys or names (e.g., `std::string`). + The comparison function `std::less<StringType>` is used to order elements + inside the container. + @tparam AllocatorType the allocator to use for objects (e.g., + `std::allocator`) + + #### Default type + + With the default values for @a ObjectType (`std::map`), @a StringType + (`std::string`), and @a AllocatorType (`std::allocator`), the default + value for @a object_t is: + + @code {.cpp} + std::map< + std::string, // key_type + basic_json, // value_type + std::less<std::string>, // key_compare + std::allocator<std::pair<const std::string, basic_json>> // allocator_type + > + @endcode + + #### Behavior + + The choice of @a object_t influences the behavior of the JSON class. With + the default type, objects have the following behavior: + + - When all names are unique, objects will be interoperable in the sense + that all software implementations receiving that object will agree on + the name-value mappings. + - When the names within an object are not unique, it is unspecified which + one of the values for a given key will be chosen. For instance, + `{"key": 2, "key": 1}` could be equal to either `{"key": 1}` or + `{"key": 2}`. + - Internally, name/value pairs are stored in lexicographical order of the + names. Objects will also be serialized (see @ref dump) in this order. + For instance, `{"b": 1, "a": 2}` and `{"a": 2, "b": 1}` will be stored + and serialized as `{"a": 2, "b": 1}`. + - When comparing objects, the order of the name/value pairs is irrelevant. + This makes objects interoperable in the sense that they will not be + affected by these differences. For instance, `{"b": 1, "a": 2}` and + `{"a": 2, "b": 1}` will be treated as equal. + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) specifies: + > An implementation may set limits on the maximum depth of nesting. + + In this class, the object's limit of nesting is not explicitly constrained. + However, a maximum depth of nesting may be introduced by the compiler or + runtime environment. A theoretical limit can be queried by calling the + @ref max_size function of a JSON object. + + #### Storage + + Objects are stored as pointers in a @ref basic_json type. That is, for any + access to object values, a pointer of type `object_t*` must be + dereferenced. + + @sa @ref array_t -- type for an array value + + @since version 1.0.0 + + @note The order name/value pairs are added to the object is *not* + preserved by the library. Therefore, iterating an object may return + name/value pairs in a different order than they were originally stored. In + fact, keys will be traversed in alphabetical order as `std::map` with + `std::less` is used by default. Please note this behavior conforms to [RFC + 7159](http://rfc7159.net/rfc7159), because any order implements the + specified "unordered" nature of JSON objects. + */ + using object_t = ObjectType<StringType, + basic_json, + object_comparator_t, + AllocatorType<std::pair<const StringType, + basic_json>>>; + + /*! + @brief a type for an array + + [RFC 7159](http://rfc7159.net/rfc7159) describes JSON arrays as follows: + > An array is an ordered sequence of zero or more values. + + To store objects in C++, a type is defined by the template parameters + explained below. + + @tparam ArrayType container type to store arrays (e.g., `std::vector` or + `std::list`) + @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`) + + #### Default type + + With the default values for @a ArrayType (`std::vector`) and @a + AllocatorType (`std::allocator`), the default value for @a array_t is: + + @code {.cpp} + std::vector< + basic_json, // value_type + std::allocator<basic_json> // allocator_type + > + @endcode + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) specifies: + > An implementation may set limits on the maximum depth of nesting. + + In this class, the array's limit of nesting is not explicitly constrained. + However, a maximum depth of nesting may be introduced by the compiler or + runtime environment. A theoretical limit can be queried by calling the + @ref max_size function of a JSON array. + + #### Storage + + Arrays are stored as pointers in a @ref basic_json type. That is, for any + access to array values, a pointer of type `array_t*` must be dereferenced. + + @sa @ref object_t -- type for an object value + + @since version 1.0.0 + */ + using array_t = ArrayType<basic_json, AllocatorType<basic_json>>; + + /*! + @brief a type for a string + + [RFC 7159](http://rfc7159.net/rfc7159) describes JSON strings as follows: + > A string is a sequence of zero or more Unicode characters. + + To store objects in C++, a type is defined by the template parameter + described below. Unicode values are split by the JSON class into + byte-sized characters during deserialization. + + @tparam StringType the container to store strings (e.g., `std::string`). + Note this container is used for keys/names in objects, see @ref object_t. + + #### Default type + + With the default values for @a StringType (`std::string`), the default + value for @a string_t is: + + @code {.cpp} + std::string + @endcode + + #### Encoding + + Strings are stored in UTF-8 encoding. Therefore, functions like + `std::string::size()` or `std::string::length()` return the number of + bytes in the string rather than the number of characters or glyphs. + + #### String comparison + + [RFC 7159](http://rfc7159.net/rfc7159) states: + > Software implementations are typically required to test names of object + > members for equality. Implementations that transform the textual + > representation into sequences of Unicode code units and then perform the + > comparison numerically, code unit by code unit, are interoperable in the + > sense that implementations will agree in all cases on equality or + > inequality of two strings. For example, implementations that compare + > strings with escaped characters unconverted may incorrectly find that + > `"a\\b"` and `"a\u005Cb"` are not equal. + + This implementation is interoperable as it does compare strings code unit + by code unit. + + #### Storage + + String values are stored as pointers in a @ref basic_json type. That is, + for any access to string values, a pointer of type `string_t*` must be + dereferenced. + + @since version 1.0.0 + */ + using string_t = StringType; + + /*! + @brief a type for a boolean + + [RFC 7159](http://rfc7159.net/rfc7159) implicitly describes a boolean as a + type which differentiates the two literals `true` and `false`. + + To store objects in C++, a type is defined by the template parameter @a + BooleanType which chooses the type to use. + + #### Default type + + With the default values for @a BooleanType (`bool`), the default value for + @a boolean_t is: + + @code {.cpp} + bool + @endcode + + #### Storage + + Boolean values are stored directly inside a @ref basic_json type. + + @since version 1.0.0 + */ + using boolean_t = BooleanType; + + /*! + @brief a type for a number (integer) + + [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows: + > The representation of numbers is similar to that used in most + > programming languages. A number is represented in base 10 using decimal + > digits. It contains an integer component that may be prefixed with an + > optional minus sign, which may be followed by a fraction part and/or an + > exponent part. Leading zeros are not allowed. (...) Numeric values that + > cannot be represented in the grammar below (such as Infinity and NaN) + > are not permitted. + + This description includes both integer and floating-point numbers. + However, C++ allows more precise storage if it is known whether the number + is a signed integer, an unsigned integer or a floating-point number. + Therefore, three different types, @ref number_integer_t, @ref + number_unsigned_t and @ref number_float_t are used. + + To store integer numbers in C++, a type is defined by the template + parameter @a NumberIntegerType which chooses the type to use. + + #### Default type + + With the default values for @a NumberIntegerType (`int64_t`), the default + value for @a number_integer_t is: + + @code {.cpp} + int64_t + @endcode + + #### Default behavior + + - The restrictions about leading zeros is not enforced in C++. Instead, + leading zeros in integer literals lead to an interpretation as octal + number. Internally, the value will be stored as decimal number. For + instance, the C++ integer literal `010` will be serialized to `8`. + During deserialization, leading zeros yield an error. + - Not-a-number (NaN) values will be serialized to `null`. + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) specifies: + > An implementation may set limits on the range and precision of numbers. + + When the default type is used, the maximal integer number that can be + stored is `9223372036854775807` (INT64_MAX) and the minimal integer number + that can be stored is `-9223372036854775808` (INT64_MIN). Integer numbers + that are out of range will yield over/underflow when used in a + constructor. During deserialization, too large or small integer numbers + will be automatically be stored as @ref number_unsigned_t or @ref + number_float_t. + + [RFC 7159](http://rfc7159.net/rfc7159) further states: + > Note that when such software is used, numbers that are integers and are + > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense + > that implementations will agree exactly on their numeric values. + + As this range is a subrange of the exactly supported range [INT64_MIN, + INT64_MAX], this class's integer type is interoperable. + + #### Storage + + Integer number values are stored directly inside a @ref basic_json type. + + @sa @ref number_float_t -- type for number values (floating-point) + + @sa @ref number_unsigned_t -- type for number values (unsigned integer) + + @since version 1.0.0 + */ + using number_integer_t = NumberIntegerType; + + /*! + @brief a type for a number (unsigned) + + [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows: + > The representation of numbers is similar to that used in most + > programming languages. A number is represented in base 10 using decimal + > digits. It contains an integer component that may be prefixed with an + > optional minus sign, which may be followed by a fraction part and/or an + > exponent part. Leading zeros are not allowed. (...) Numeric values that + > cannot be represented in the grammar below (such as Infinity and NaN) + > are not permitted. + + This description includes both integer and floating-point numbers. + However, C++ allows more precise storage if it is known whether the number + is a signed integer, an unsigned integer or a floating-point number. + Therefore, three different types, @ref number_integer_t, @ref + number_unsigned_t and @ref number_float_t are used. + + To store unsigned integer numbers in C++, a type is defined by the + template parameter @a NumberUnsignedType which chooses the type to use. + + #### Default type + + With the default values for @a NumberUnsignedType (`uint64_t`), the + default value for @a number_unsigned_t is: + + @code {.cpp} + uint64_t + @endcode + + #### Default behavior + + - The restrictions about leading zeros is not enforced in C++. Instead, + leading zeros in integer literals lead to an interpretation as octal + number. Internally, the value will be stored as decimal number. For + instance, the C++ integer literal `010` will be serialized to `8`. + During deserialization, leading zeros yield an error. + - Not-a-number (NaN) values will be serialized to `null`. + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) specifies: + > An implementation may set limits on the range and precision of numbers. + + When the default type is used, the maximal integer number that can be + stored is `18446744073709551615` (UINT64_MAX) and the minimal integer + number that can be stored is `0`. Integer numbers that are out of range + will yield over/underflow when used in a constructor. During + deserialization, too large or small integer numbers will be automatically + be stored as @ref number_integer_t or @ref number_float_t. + + [RFC 7159](http://rfc7159.net/rfc7159) further states: + > Note that when such software is used, numbers that are integers and are + > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense + > that implementations will agree exactly on their numeric values. + + As this range is a subrange (when considered in conjunction with the + number_integer_t type) of the exactly supported range [0, UINT64_MAX], + this class's integer type is interoperable. + + #### Storage + + Integer number values are stored directly inside a @ref basic_json type. + + @sa @ref number_float_t -- type for number values (floating-point) + @sa @ref number_integer_t -- type for number values (integer) + + @since version 2.0.0 + */ + using number_unsigned_t = NumberUnsignedType; + + /*! + @brief a type for a number (floating-point) + + [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows: + > The representation of numbers is similar to that used in most + > programming languages. A number is represented in base 10 using decimal + > digits. It contains an integer component that may be prefixed with an + > optional minus sign, which may be followed by a fraction part and/or an + > exponent part. Leading zeros are not allowed. (...) Numeric values that + > cannot be represented in the grammar below (such as Infinity and NaN) + > are not permitted. + + This description includes both integer and floating-point numbers. + However, C++ allows more precise storage if it is known whether the number + is a signed integer, an unsigned integer or a floating-point number. + Therefore, three different types, @ref number_integer_t, @ref + number_unsigned_t and @ref number_float_t are used. + + To store floating-point numbers in C++, a type is defined by the template + parameter @a NumberFloatType which chooses the type to use. + + #### Default type + + With the default values for @a NumberFloatType (`double`), the default + value for @a number_float_t is: + + @code {.cpp} + double + @endcode + + #### Default behavior + + - The restrictions about leading zeros is not enforced in C++. Instead, + leading zeros in floating-point literals will be ignored. Internally, + the value will be stored as decimal number. For instance, the C++ + floating-point literal `01.2` will be serialized to `1.2`. During + deserialization, leading zeros yield an error. + - Not-a-number (NaN) values will be serialized to `null`. + + #### Limits + + [RFC 7159](http://rfc7159.net/rfc7159) states: + > This specification allows implementations to set limits on the range and + > precision of numbers accepted. Since software that implements IEEE + > 754-2008 binary64 (double precision) numbers is generally available and + > widely used, good interoperability can be achieved by implementations + > that expect no more precision or range than these provide, in the sense + > that implementations will approximate JSON numbers within the expected + > precision. + + This implementation does exactly follow this approach, as it uses double + precision floating-point numbers. Note values smaller than + `-1.79769313486232e+308` and values greater than `1.79769313486232e+308` + will be stored as NaN internally and be serialized to `null`. + + #### Storage + + Floating-point number values are stored directly inside a @ref basic_json + type. + + @sa @ref number_integer_t -- type for number values (integer) + + @sa @ref number_unsigned_t -- type for number values (unsigned integer) + + @since version 1.0.0 + */ + using number_float_t = NumberFloatType; + + /// @} + + private: + + /// helper for exception-safe object creation + template<typename T, typename... Args> + static T* create(Args&& ... args) + { + AllocatorType<T> alloc; + using AllocatorTraits = std::allocator_traits<AllocatorType<T>>; + + auto deleter = [&](T * object) + { + AllocatorTraits::deallocate(alloc, object, 1); + }; + std::unique_ptr<T, decltype(deleter)> object(AllocatorTraits::allocate(alloc, 1), deleter); + AllocatorTraits::construct(alloc, object.get(), std::forward<Args>(args)...); + assert(object != nullptr); + return object.release(); + } + + //////////////////////// + // JSON value storage // + //////////////////////// + + /*! + @brief a JSON value + + The actual storage for a JSON value of the @ref basic_json class. This + union combines the different storage types for the JSON value types + defined in @ref value_t. + + JSON type | value_t type | used type + --------- | --------------- | ------------------------ + object | object | pointer to @ref object_t + array | array | pointer to @ref array_t + string | string | pointer to @ref string_t + boolean | boolean | @ref boolean_t + number | number_integer | @ref number_integer_t + number | number_unsigned | @ref number_unsigned_t + number | number_float | @ref number_float_t + null | null | *no value is stored* + + @note Variable-length types (objects, arrays, and strings) are stored as + pointers. The size of the union should not exceed 64 bits if the default + value types are used. + + @since version 1.0.0 + */ + union json_value + { + /// object (stored with pointer to save storage) + object_t* object; + /// array (stored with pointer to save storage) + array_t* array; + /// string (stored with pointer to save storage) + string_t* string; + /// boolean + boolean_t boolean; + /// number (integer) + number_integer_t number_integer; + /// number (unsigned integer) + number_unsigned_t number_unsigned; + /// number (floating-point) + number_float_t number_float; + + /// default constructor (for null values) + json_value() = default; + /// constructor for booleans + json_value(boolean_t v) noexcept : boolean(v) {} + /// constructor for numbers (integer) + json_value(number_integer_t v) noexcept : number_integer(v) {} + /// constructor for numbers (unsigned) + json_value(number_unsigned_t v) noexcept : number_unsigned(v) {} + /// constructor for numbers (floating-point) + json_value(number_float_t v) noexcept : number_float(v) {} + /// constructor for empty values of a given type + json_value(value_t t) + { + switch (t) + { + case value_t::object: + { + object = create<object_t>(); + break; + } + + case value_t::array: + { + array = create<array_t>(); + break; + } + + case value_t::string: + { + string = create<string_t>(""); + break; + } + + case value_t::boolean: + { + boolean = boolean_t(false); + break; + } + + case value_t::number_integer: + { + number_integer = number_integer_t(0); + break; + } + + case value_t::number_unsigned: + { + number_unsigned = number_unsigned_t(0); + break; + } + + case value_t::number_float: + { + number_float = number_float_t(0.0); + break; + } + + case value_t::null: + { + object = nullptr; // silence warning, see #821 + break; + } + + default: + { + object = nullptr; // silence warning, see #821 + if (JSON_UNLIKELY(t == value_t::null)) + { + JSON_THROW(other_error::create(500, "961c151d2e87f2686a955a9be24d316f1362bf21 3.1.2")); // LCOV_EXCL_LINE + } + break; + } + } + } + + /// constructor for strings + json_value(const string_t& value) + { + string = create<string_t>(value); + } + + /// constructor for rvalue strings + json_value(string_t&& value) + { + string = create<string_t>(std::move(value)); + } + + /// constructor for objects + json_value(const object_t& value) + { + object = create<object_t>(value); + } + + /// constructor for rvalue objects + json_value(object_t&& value) + { + object = create<object_t>(std::move(value)); + } + + /// constructor for arrays + json_value(const array_t& value) + { + array = create<array_t>(value); + } + + /// constructor for rvalue arrays + json_value(array_t&& value) + { + array = create<array_t>(std::move(value)); + } + + void destroy(value_t t) noexcept + { + switch (t) + { + case value_t::object: + { + AllocatorType<object_t> alloc; + std::allocator_traits<decltype(alloc)>::destroy(alloc, object); + std::allocator_traits<decltype(alloc)>::deallocate(alloc, object, 1); + break; + } + + case value_t::array: + { + AllocatorType<array_t> alloc; + std::allocator_traits<decltype(alloc)>::destroy(alloc, array); + std::allocator_traits<decltype(alloc)>::deallocate(alloc, array, 1); + break; + } + + case value_t::string: + { + AllocatorType<string_t> alloc; + std::allocator_traits<decltype(alloc)>::destroy(alloc, string); + std::allocator_traits<decltype(alloc)>::deallocate(alloc, string, 1); + break; + } + + default: + { + break; + } + } + } + }; + + /*! + @brief checks the class invariants + + This function asserts the class invariants. It needs to be called at the + end of every constructor to make sure that created objects respect the + invariant. Furthermore, it has to be called each time the type of a JSON + value is changed, because the invariant expresses a relationship between + @a m_type and @a m_value. + */ + void assert_invariant() const noexcept + { + assert(m_type != value_t::object or m_value.object != nullptr); + assert(m_type != value_t::array or m_value.array != nullptr); + assert(m_type != value_t::string or m_value.string != nullptr); + } + + public: + ////////////////////////// + // JSON parser callback // + ////////////////////////// + + /*! + @brief parser event types + + The parser callback distinguishes the following events: + - `object_start`: the parser read `{` and started to process a JSON object + - `key`: the parser read a key of a value in an object + - `object_end`: the parser read `}` and finished processing a JSON object + - `array_start`: the parser read `[` and started to process a JSON array + - `array_end`: the parser read `]` and finished processing a JSON array + - `value`: the parser finished reading a JSON value + + @image html callback_events.png "Example when certain parse events are triggered" + + @sa @ref parser_callback_t for more information and examples + */ + using parse_event_t = typename parser::parse_event_t; + + /*! + @brief per-element parser callback type + + With a parser callback function, the result of parsing a JSON text can be + influenced. When passed to @ref parse, it is called on certain events + (passed as @ref parse_event_t via parameter @a event) with a set recursion + depth @a depth and context JSON value @a parsed. The return value of the + callback function is a boolean indicating whether the element that emitted + the callback shall be kept or not. + + We distinguish six scenarios (determined by the event type) in which the + callback function can be called. The following table describes the values + of the parameters @a depth, @a event, and @a parsed. + + parameter @a event | description | parameter @a depth | parameter @a parsed + ------------------ | ----------- | ------------------ | ------------------- + parse_event_t::object_start | the parser read `{` and started to process a JSON object | depth of the parent of the JSON object | a JSON value with type discarded + parse_event_t::key | the parser read a key of a value in an object | depth of the currently parsed JSON object | a JSON string containing the key + parse_event_t::object_end | the parser read `}` and finished processing a JSON object | depth of the parent of the JSON object | the parsed JSON object + parse_event_t::array_start | the parser read `[` and started to process a JSON array | depth of the parent of the JSON array | a JSON value with type discarded + parse_event_t::array_end | the parser read `]` and finished processing a JSON array | depth of the parent of the JSON array | the parsed JSON array + parse_event_t::value | the parser finished reading a JSON value | depth of the value | the parsed JSON value + + @image html callback_events.png "Example when certain parse events are triggered" + + Discarding a value (i.e., returning `false`) has different effects + depending on the context in which function was called: + + - Discarded values in structured types are skipped. That is, the parser + will behave as if the discarded value was never read. + - In case a value outside a structured type is skipped, it is replaced + with `null`. This case happens if the top-level element is skipped. + + @param[in] depth the depth of the recursion during parsing + + @param[in] event an event of type parse_event_t indicating the context in + the callback function has been called + + @param[in,out] parsed the current intermediate parse result; note that + writing to this value has no effect for parse_event_t::key events + + @return Whether the JSON value which called the function during parsing + should be kept (`true`) or not (`false`). In the latter case, it is either + skipped completely or replaced by an empty discarded object. + + @sa @ref parse for examples + + @since version 1.0.0 + */ + using parser_callback_t = typename parser::parser_callback_t; + + using json_sax_t = typename parser::json_sax_t; + + ////////////////// + // constructors // + ////////////////// + + /// @name constructors and destructors + /// Constructors of class @ref basic_json, copy/move constructor, copy + /// assignment, static functions creating objects, and the destructor. + /// @{ + + /*! + @brief create an empty value with a given type + + Create an empty JSON value with a given type. The value will be default + initialized with an empty value which depends on the type: + + Value type | initial value + ----------- | ------------- + null | `null` + boolean | `false` + string | `""` + number | `0` + object | `{}` + array | `[]` + + @param[in] v the type of the value to create + + @complexity Constant. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The following code shows the constructor for different @ref + value_t values,basic_json__value_t} + + @sa @ref clear() -- restores the postcondition of this constructor + + @since version 1.0.0 + */ + basic_json(const value_t v) + : m_type(v), m_value(v) + { + assert_invariant(); + } + + /*! + @brief create a null object + + Create a `null` JSON value. It either takes a null pointer as parameter + (explicitly creating `null`) or no parameter (implicitly creating `null`). + The passed null pointer itself is not read -- it is only used to choose + the right constructor. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this constructor never throws + exceptions. + + @liveexample{The following code shows the constructor with and without a + null pointer parameter.,basic_json__nullptr_t} + + @since version 1.0.0 + */ + basic_json(std::nullptr_t = nullptr) noexcept + : basic_json(value_t::null) + { + assert_invariant(); + } + + /*! + @brief create a JSON value + + This is a "catch all" constructor for all compatible JSON types; that is, + types for which a `to_json()` method exists. The constructor forwards the + parameter @a val to that method (to `json_serializer<U>::to_json` method + with `U = uncvref_t<CompatibleType>`, to be exact). + + Template type @a CompatibleType includes, but is not limited to, the + following types: + - **arrays**: @ref array_t and all kinds of compatible containers such as + `std::vector`, `std::deque`, `std::list`, `std::forward_list`, + `std::array`, `std::valarray`, `std::set`, `std::unordered_set`, + `std::multiset`, and `std::unordered_multiset` with a `value_type` from + which a @ref basic_json value can be constructed. + - **objects**: @ref object_t and all kinds of compatible associative + containers such as `std::map`, `std::unordered_map`, `std::multimap`, + and `std::unordered_multimap` with a `key_type` compatible to + @ref string_t and a `value_type` from which a @ref basic_json value can + be constructed. + - **strings**: @ref string_t, string literals, and all compatible string + containers can be used. + - **numbers**: @ref number_integer_t, @ref number_unsigned_t, + @ref number_float_t, and all convertible number types such as `int`, + `size_t`, `int64_t`, `float` or `double` can be used. + - **boolean**: @ref boolean_t / `bool` can be used. + + See the examples below. + + @tparam CompatibleType a type such that: + - @a CompatibleType is not derived from `std::istream`, + - @a CompatibleType is not @ref basic_json (to avoid hijacking copy/move + constructors), + - @a CompatibleType is not a different @ref basic_json type (i.e. with different template arguments) + - @a CompatibleType is not a @ref basic_json nested type (e.g., + @ref json_pointer, @ref iterator, etc ...) + - @ref @ref json_serializer<U> has a + `to_json(basic_json_t&, CompatibleType&&)` method + + @tparam U = `uncvref_t<CompatibleType>` + + @param[in] val the value to be forwarded to the respective constructor + + @complexity Usually linear in the size of the passed @a val, also + depending on the implementation of the called `to_json()` + method. + + @exceptionsafety Depends on the called constructor. For types directly + supported by the library (i.e., all types for which no `to_json()` function + was provided), strong guarantee holds: if an exception is thrown, there are + no changes to any JSON value. + + @liveexample{The following code shows the constructor with several + compatible types.,basic_json__CompatibleType} + + @since version 2.1.0 + */ + template <typename CompatibleType, + typename U = detail::uncvref_t<CompatibleType>, + detail::enable_if_t< + detail::is_compatible_type<basic_json_t, U>::value, int> = 0> + basic_json(CompatibleType && val) noexcept(noexcept( + JSONSerializer<U>::to_json(std::declval<basic_json_t&>(), + std::forward<CompatibleType>(val)))) + { + JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val)); + assert_invariant(); + } + + /*! + @brief create a JSON value from an existing one + + This is a constructor for existing @ref basic_json types. + It does not hijack copy/move constructors, since the parameter has different + template arguments than the current ones. + + The constructor tries to convert the internal @ref m_value of the parameter. + + @tparam BasicJsonType a type such that: + - @a BasicJsonType is a @ref basic_json type. + - @a BasicJsonType has different template arguments than @ref basic_json_t. + + @param[in] val the @ref basic_json value to be converted. + + @complexity Usually linear in the size of the passed @a val, also + depending on the implementation of the called `to_json()` + method. + + @exceptionsafety Depends on the called constructor. For types directly + supported by the library (i.e., all types for which no `to_json()` function + was provided), strong guarantee holds: if an exception is thrown, there are + no changes to any JSON value. + + @since version 3.1.2 + */ + template <typename BasicJsonType, + detail::enable_if_t< + detail::is_basic_json<BasicJsonType>::value and not std::is_same<basic_json, BasicJsonType>::value, int> = 0> + basic_json(const BasicJsonType& val) + { + using other_boolean_t = typename BasicJsonType::boolean_t; + using other_number_float_t = typename BasicJsonType::number_float_t; + using other_number_integer_t = typename BasicJsonType::number_integer_t; + using other_number_unsigned_t = typename BasicJsonType::number_unsigned_t; + using other_string_t = typename BasicJsonType::string_t; + using other_object_t = typename BasicJsonType::object_t; + using other_array_t = typename BasicJsonType::array_t; + + switch (val.type()) + { + case value_t::boolean: + JSONSerializer<other_boolean_t>::to_json(*this, val.template get<other_boolean_t>()); + break; + case value_t::number_float: + JSONSerializer<other_number_float_t>::to_json(*this, val.template get<other_number_float_t>()); + break; + case value_t::number_integer: + JSONSerializer<other_number_integer_t>::to_json(*this, val.template get<other_number_integer_t>()); + break; + case value_t::number_unsigned: + JSONSerializer<other_number_unsigned_t>::to_json(*this, val.template get<other_number_unsigned_t>()); + break; + case value_t::string: + JSONSerializer<other_string_t>::to_json(*this, val.template get_ref<const other_string_t&>()); + break; + case value_t::object: + JSONSerializer<other_object_t>::to_json(*this, val.template get_ref<const other_object_t&>()); + break; + case value_t::array: + JSONSerializer<other_array_t>::to_json(*this, val.template get_ref<const other_array_t&>()); + break; + case value_t::null: + *this = nullptr; + break; + case value_t::discarded: + m_type = value_t::discarded; + break; + } + assert_invariant(); + } + + /*! + @brief create a container (array or object) from an initializer list + + Creates a JSON value of type array or object from the passed initializer + list @a init. In case @a type_deduction is `true` (default), the type of + the JSON value to be created is deducted from the initializer list @a init + according to the following rules: + + 1. If the list is empty, an empty JSON object value `{}` is created. + 2. If the list consists of pairs whose first element is a string, a JSON + object value is created where the first elements of the pairs are + treated as keys and the second elements are as values. + 3. In all other cases, an array is created. + + The rules aim to create the best fit between a C++ initializer list and + JSON values. The rationale is as follows: + + 1. The empty initializer list is written as `{}` which is exactly an empty + JSON object. + 2. C++ has no way of describing mapped types other than to list a list of + pairs. As JSON requires that keys must be of type string, rule 2 is the + weakest constraint one can pose on initializer lists to interpret them + as an object. + 3. In all other cases, the initializer list could not be interpreted as + JSON object type, so interpreting it as JSON array type is safe. + + With the rules described above, the following JSON values cannot be + expressed by an initializer list: + + - the empty array (`[]`): use @ref array(initializer_list_t) + with an empty initializer list in this case + - arrays whose elements satisfy rule 2: use @ref + array(initializer_list_t) with the same initializer list + in this case + + @note When used without parentheses around an empty initializer list, @ref + basic_json() is called instead of this function, yielding the JSON null + value. + + @param[in] init initializer list with JSON values + + @param[in] type_deduction internal parameter; when set to `true`, the type + of the JSON value is deducted from the initializer list @a init; when set + to `false`, the type provided via @a manual_type is forced. This mode is + used by the functions @ref array(initializer_list_t) and + @ref object(initializer_list_t). + + @param[in] manual_type internal parameter; when @a type_deduction is set + to `false`, the created JSON value will use the provided type (only @ref + value_t::array and @ref value_t::object are valid); when @a type_deduction + is set to `true`, this parameter has no effect + + @throw type_error.301 if @a type_deduction is `false`, @a manual_type is + `value_t::object`, but @a init contains an element which is not a pair + whose first element is a string. In this case, the constructor could not + create an object. If @a type_deduction would have be `true`, an array + would have been created. See @ref object(initializer_list_t) + for an example. + + @complexity Linear in the size of the initializer list @a init. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The example below shows how JSON values are created from + initializer lists.,basic_json__list_init_t} + + @sa @ref array(initializer_list_t) -- create a JSON array + value from an initializer list + @sa @ref object(initializer_list_t) -- create a JSON object + value from an initializer list + + @since version 1.0.0 + */ + basic_json(initializer_list_t init, + bool type_deduction = true, + value_t manual_type = value_t::array) + { + // check if each element is an array with two elements whose first + // element is a string + bool is_an_object = std::all_of(init.begin(), init.end(), + [](const detail::json_ref<basic_json>& element_ref) + { + return (element_ref->is_array() and element_ref->size() == 2 and (*element_ref)[0].is_string()); + }); + + // adjust type if type deduction is not wanted + if (not type_deduction) + { + // if array is wanted, do not create an object though possible + if (manual_type == value_t::array) + { + is_an_object = false; + } + + // if object is wanted but impossible, throw an exception + if (JSON_UNLIKELY(manual_type == value_t::object and not is_an_object)) + { + JSON_THROW(type_error::create(301, "cannot create object from initializer list")); + } + } + + if (is_an_object) + { + // the initializer list is a list of pairs -> create object + m_type = value_t::object; + m_value = value_t::object; + + std::for_each(init.begin(), init.end(), [this](const detail::json_ref<basic_json>& element_ref) + { + auto element = element_ref.moved_or_copied(); + m_value.object->emplace( + std::move(*((*element.m_value.array)[0].m_value.string)), + std::move((*element.m_value.array)[1])); + }); + } + else + { + // the initializer list describes an array -> create array + m_type = value_t::array; + m_value.array = create<array_t>(init.begin(), init.end()); + } + + assert_invariant(); + } + + /*! + @brief explicitly create an array from an initializer list + + Creates a JSON array value from a given initializer list. That is, given a + list of values `a, b, c`, creates the JSON value `[a, b, c]`. If the + initializer list is empty, the empty array `[]` is created. + + @note This function is only needed to express two edge cases that cannot + be realized with the initializer list constructor (@ref + basic_json(initializer_list_t, bool, value_t)). These cases + are: + 1. creating an array whose elements are all pairs whose first element is a + string -- in this case, the initializer list constructor would create an + object, taking the first elements as keys + 2. creating an empty array -- passing the empty initializer list to the + initializer list constructor yields an empty object + + @param[in] init initializer list with JSON values to create an array from + (optional) + + @return JSON array value + + @complexity Linear in the size of @a init. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The following code shows an example for the `array` + function.,array} + + @sa @ref basic_json(initializer_list_t, bool, value_t) -- + create a JSON value from an initializer list + @sa @ref object(initializer_list_t) -- create a JSON object + value from an initializer list + + @since version 1.0.0 + */ + static basic_json array(initializer_list_t init = {}) + { + return basic_json(init, false, value_t::array); + } + + /*! + @brief explicitly create an object from an initializer list + + Creates a JSON object value from a given initializer list. The initializer + lists elements must be pairs, and their first elements must be strings. If + the initializer list is empty, the empty object `{}` is created. + + @note This function is only added for symmetry reasons. In contrast to the + related function @ref array(initializer_list_t), there are + no cases which can only be expressed by this function. That is, any + initializer list @a init can also be passed to the initializer list + constructor @ref basic_json(initializer_list_t, bool, value_t). + + @param[in] init initializer list to create an object from (optional) + + @return JSON object value + + @throw type_error.301 if @a init is not a list of pairs whose first + elements are strings. In this case, no object can be created. When such a + value is passed to @ref basic_json(initializer_list_t, bool, value_t), + an array would have been created from the passed initializer list @a init. + See example below. + + @complexity Linear in the size of @a init. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The following code shows an example for the `object` + function.,object} + + @sa @ref basic_json(initializer_list_t, bool, value_t) -- + create a JSON value from an initializer list + @sa @ref array(initializer_list_t) -- create a JSON array + value from an initializer list + + @since version 1.0.0 + */ + static basic_json object(initializer_list_t init = {}) + { + return basic_json(init, false, value_t::object); + } + + /*! + @brief construct an array with count copies of given value + + Constructs a JSON array value by creating @a cnt copies of a passed value. + In case @a cnt is `0`, an empty array is created. + + @param[in] cnt the number of JSON copies of @a val to create + @param[in] val the JSON value to copy + + @post `std::distance(begin(),end()) == cnt` holds. + + @complexity Linear in @a cnt. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The following code shows examples for the @ref + basic_json(size_type\, const basic_json&) + constructor.,basic_json__size_type_basic_json} + + @since version 1.0.0 + */ + basic_json(size_type cnt, const basic_json& val) + : m_type(value_t::array) + { + m_value.array = create<array_t>(cnt, val); + assert_invariant(); + } + + /*! + @brief construct a JSON container given an iterator range + + Constructs the JSON value with the contents of the range `[first, last)`. + The semantics depends on the different types a JSON value can have: + - In case of a null type, invalid_iterator.206 is thrown. + - In case of other primitive types (number, boolean, or string), @a first + must be `begin()` and @a last must be `end()`. In this case, the value is + copied. Otherwise, invalid_iterator.204 is thrown. + - In case of structured types (array, object), the constructor behaves as + similar versions for `std::vector` or `std::map`; that is, a JSON array + or object is constructed from the values in the range. + + @tparam InputIT an input iterator type (@ref iterator or @ref + const_iterator) + + @param[in] first begin of the range to copy from (included) + @param[in] last end of the range to copy from (excluded) + + @pre Iterators @a first and @a last must be initialized. **This + precondition is enforced with an assertion (see warning).** If + assertions are switched off, a violation of this precondition yields + undefined behavior. + + @pre Range `[first, last)` is valid. Usually, this precondition cannot be + checked efficiently. Only certain edge cases are detected; see the + description of the exceptions below. A violation of this precondition + yields undefined behavior. + + @warning A precondition is enforced with a runtime assertion that will + result in calling `std::abort` if this precondition is not met. + Assertions can be disabled by defining `NDEBUG` at compile time. + See https://en.cppreference.com/w/cpp/error/assert for more + information. + + @throw invalid_iterator.201 if iterators @a first and @a last are not + compatible (i.e., do not belong to the same JSON value). In this case, + the range `[first, last)` is undefined. + @throw invalid_iterator.204 if iterators @a first and @a last belong to a + primitive type (number, boolean, or string), but @a first does not point + to the first element any more. In this case, the range `[first, last)` is + undefined. See example code below. + @throw invalid_iterator.206 if iterators @a first and @a last belong to a + null value. In this case, the range `[first, last)` is undefined. + + @complexity Linear in distance between @a first and @a last. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @liveexample{The example below shows several ways to create JSON values by + specifying a subrange with iterators.,basic_json__InputIt_InputIt} + + @since version 1.0.0 + */ + template<class InputIT, typename std::enable_if< + std::is_same<InputIT, typename basic_json_t::iterator>::value or + std::is_same<InputIT, typename basic_json_t::const_iterator>::value, int>::type = 0> + basic_json(InputIT first, InputIT last) + { + assert(first.m_object != nullptr); + assert(last.m_object != nullptr); + + // make sure iterator fits the current value + if (JSON_UNLIKELY(first.m_object != last.m_object)) + { + JSON_THROW(invalid_iterator::create(201, "iterators are not compatible")); + } + + // copy type from first iterator + m_type = first.m_object->m_type; + + // check if iterator range is complete for primitive values + switch (m_type) + { + case value_t::boolean: + case value_t::number_float: + case value_t::number_integer: + case value_t::number_unsigned: + case value_t::string: + { + if (JSON_UNLIKELY(not first.m_it.primitive_iterator.is_begin() + or not last.m_it.primitive_iterator.is_end())) + { + JSON_THROW(invalid_iterator::create(204, "iterators out of range")); + } + break; + } + + default: + break; + } + + switch (m_type) + { + case value_t::number_integer: + { + m_value.number_integer = first.m_object->m_value.number_integer; + break; + } + + case value_t::number_unsigned: + { + m_value.number_unsigned = first.m_object->m_value.number_unsigned; + break; + } + + case value_t::number_float: + { + m_value.number_float = first.m_object->m_value.number_float; + break; + } + + case value_t::boolean: + { + m_value.boolean = first.m_object->m_value.boolean; + break; + } + + case value_t::string: + { + m_value = *first.m_object->m_value.string; + break; + } + + case value_t::object: + { + m_value.object = create<object_t>(first.m_it.object_iterator, + last.m_it.object_iterator); + break; + } + + case value_t::array: + { + m_value.array = create<array_t>(first.m_it.array_iterator, + last.m_it.array_iterator); + break; + } + + default: + JSON_THROW(invalid_iterator::create(206, "cannot construct with iterators from " + + std::string(first.m_object->type_name()))); + } + + assert_invariant(); + } + + + /////////////////////////////////////// + // other constructors and destructor // + /////////////////////////////////////// + + /// @private + basic_json(const detail::json_ref<basic_json>& ref) + : basic_json(ref.moved_or_copied()) + {} + + /*! + @brief copy constructor + + Creates a copy of a given JSON value. + + @param[in] other the JSON value to copy + + @post `*this == other` + + @complexity Linear in the size of @a other. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes to any JSON value. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is linear. + - As postcondition, it holds: `other == basic_json(other)`. + + @liveexample{The following code shows an example for the copy + constructor.,basic_json__basic_json} + + @since version 1.0.0 + */ + basic_json(const basic_json& other) + : m_type(other.m_type) + { + // check of passed value is valid + other.assert_invariant(); + + switch (m_type) + { + case value_t::object: + { + m_value = *other.m_value.object; + break; + } + + case value_t::array: + { + m_value = *other.m_value.array; + break; + } + + case value_t::string: + { + m_value = *other.m_value.string; + break; + } + + case value_t::boolean: + { + m_value = other.m_value.boolean; + break; + } + + case value_t::number_integer: + { + m_value = other.m_value.number_integer; + break; + } + + case value_t::number_unsigned: + { + m_value = other.m_value.number_unsigned; + break; + } + + case value_t::number_float: + { + m_value = other.m_value.number_float; + break; + } + + default: + break; + } + + assert_invariant(); + } + + /*! + @brief move constructor + + Move constructor. Constructs a JSON value with the contents of the given + value @a other using move semantics. It "steals" the resources from @a + other and leaves it as JSON null value. + + @param[in,out] other value to move to this object + + @post `*this` has the same value as @a other before the call. + @post @a other is a JSON null value. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this constructor never throws + exceptions. + + @requirement This function helps `basic_json` satisfying the + [MoveConstructible](https://en.cppreference.com/w/cpp/named_req/MoveConstructible) + requirements. + + @liveexample{The code below shows the move constructor explicitly called + via std::move.,basic_json__moveconstructor} + + @since version 1.0.0 + */ + basic_json(basic_json&& other) noexcept + : m_type(std::move(other.m_type)), + m_value(std::move(other.m_value)) + { + // check that passed value is valid + other.assert_invariant(); + + // invalidate payload + other.m_type = value_t::null; + other.m_value = {}; + + assert_invariant(); + } + + /*! + @brief copy assignment + + Copy assignment operator. Copies a JSON value via the "copy and swap" + strategy: It is expressed in terms of the copy constructor, destructor, + and the `swap()` member function. + + @param[in] other value to copy from + + @complexity Linear. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is linear. + + @liveexample{The code below shows and example for the copy assignment. It + creates a copy of value `a` which is then swapped with `b`. Finally\, the + copy of `a` (which is the null value after the swap) is + destroyed.,basic_json__copyassignment} + + @since version 1.0.0 + */ + reference& operator=(basic_json other) noexcept ( + std::is_nothrow_move_constructible<value_t>::value and + std::is_nothrow_move_assignable<value_t>::value and + std::is_nothrow_move_constructible<json_value>::value and + std::is_nothrow_move_assignable<json_value>::value + ) + { + // check that passed value is valid + other.assert_invariant(); + + using std::swap; + swap(m_type, other.m_type); + swap(m_value, other.m_value); + + assert_invariant(); + return *this; + } + + /*! + @brief destructor + + Destroys the JSON value and frees all allocated memory. + + @complexity Linear. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is linear. + - All stored elements are destroyed and all memory is freed. + + @since version 1.0.0 + */ + ~basic_json() noexcept + { + assert_invariant(); + m_value.destroy(m_type); + } + + /// @} + + public: + /////////////////////// + // object inspection // + /////////////////////// + + /// @name object inspection + /// Functions to inspect the type of a JSON value. + /// @{ + + /*! + @brief serialization + + Serialization function for JSON values. The function tries to mimic + Python's `json.dumps()` function, and currently supports its @a indent + and @a ensure_ascii parameters. + + @param[in] indent If indent is nonnegative, then array elements and object + members will be pretty-printed with that indent level. An indent level of + `0` will only insert newlines. `-1` (the default) selects the most compact + representation. + @param[in] indent_char The character to use for indentation if @a indent is + greater than `0`. The default is ` ` (space). + @param[in] ensure_ascii If @a ensure_ascii is true, all non-ASCII characters + in the output are escaped with `\uXXXX` sequences, and the result consists + of ASCII characters only. + + @return string containing the serialization of the JSON value + + @throw type_error.316 if a string stored inside the JSON value is not + UTF-8 encoded + + @complexity Linear. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @liveexample{The following example shows the effect of different @a indent\, + @a indent_char\, and @a ensure_ascii parameters to the result of the + serialization.,dump} + + @see https://docs.python.org/2/library/json.html#json.dump + + @since version 1.0.0; indentation character @a indent_char, option + @a ensure_ascii and exceptions added in version 3.0.0 + */ + string_t dump(const int indent = -1, const char indent_char = ' ', + const bool ensure_ascii = false) const + { + string_t result; + serializer s(detail::output_adapter<char, string_t>(result), indent_char); + + if (indent >= 0) + { + s.dump(*this, true, ensure_ascii, static_cast<unsigned int>(indent)); + } + else + { + s.dump(*this, false, ensure_ascii, 0); + } + + return result; + } + + /*! + @brief return the type of the JSON value (explicit) + + Return the type of the JSON value as a value from the @ref value_t + enumeration. + + @return the type of the JSON value + Value type | return value + ------------------------- | ------------------------- + null | value_t::null + boolean | value_t::boolean + string | value_t::string + number (integer) | value_t::number_integer + number (unsigned integer) | value_t::number_unsigned + number (floating-point) | value_t::number_float + object | value_t::object + array | value_t::array + discarded | value_t::discarded + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `type()` for all JSON + types.,type} + + @sa @ref operator value_t() -- return the type of the JSON value (implicit) + @sa @ref type_name() -- return the type as string + + @since version 1.0.0 + */ + constexpr value_t type() const noexcept + { + return m_type; + } + + /*! + @brief return whether type is primitive + + This function returns true if and only if the JSON type is primitive + (string, number, boolean, or null). + + @return `true` if type is primitive (string, number, boolean, or null), + `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_primitive()` for all JSON + types.,is_primitive} + + @sa @ref is_structured() -- returns whether JSON value is structured + @sa @ref is_null() -- returns whether JSON value is `null` + @sa @ref is_string() -- returns whether JSON value is a string + @sa @ref is_boolean() -- returns whether JSON value is a boolean + @sa @ref is_number() -- returns whether JSON value is a number + + @since version 1.0.0 + */ + constexpr bool is_primitive() const noexcept + { + return is_null() or is_string() or is_boolean() or is_number(); + } + + /*! + @brief return whether type is structured + + This function returns true if and only if the JSON type is structured + (array or object). + + @return `true` if type is structured (array or object), `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_structured()` for all JSON + types.,is_structured} + + @sa @ref is_primitive() -- returns whether value is primitive + @sa @ref is_array() -- returns whether value is an array + @sa @ref is_object() -- returns whether value is an object + + @since version 1.0.0 + */ + constexpr bool is_structured() const noexcept + { + return is_array() or is_object(); + } + + /*! + @brief return whether value is null + + This function returns true if and only if the JSON value is null. + + @return `true` if type is null, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_null()` for all JSON + types.,is_null} + + @since version 1.0.0 + */ + constexpr bool is_null() const noexcept + { + return (m_type == value_t::null); + } + + /*! + @brief return whether value is a boolean + + This function returns true if and only if the JSON value is a boolean. + + @return `true` if type is boolean, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_boolean()` for all JSON + types.,is_boolean} + + @since version 1.0.0 + */ + constexpr bool is_boolean() const noexcept + { + return (m_type == value_t::boolean); + } + + /*! + @brief return whether value is a number + + This function returns true if and only if the JSON value is a number. This + includes both integer (signed and unsigned) and floating-point values. + + @return `true` if type is number (regardless whether integer, unsigned + integer or floating-type), `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_number()` for all JSON + types.,is_number} + + @sa @ref is_number_integer() -- check if value is an integer or unsigned + integer number + @sa @ref is_number_unsigned() -- check if value is an unsigned integer + number + @sa @ref is_number_float() -- check if value is a floating-point number + + @since version 1.0.0 + */ + constexpr bool is_number() const noexcept + { + return is_number_integer() or is_number_float(); + } + + /*! + @brief return whether value is an integer number + + This function returns true if and only if the JSON value is a signed or + unsigned integer number. This excludes floating-point values. + + @return `true` if type is an integer or unsigned integer number, `false` + otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_number_integer()` for all + JSON types.,is_number_integer} + + @sa @ref is_number() -- check if value is a number + @sa @ref is_number_unsigned() -- check if value is an unsigned integer + number + @sa @ref is_number_float() -- check if value is a floating-point number + + @since version 1.0.0 + */ + constexpr bool is_number_integer() const noexcept + { + return (m_type == value_t::number_integer or m_type == value_t::number_unsigned); + } + + /*! + @brief return whether value is an unsigned integer number + + This function returns true if and only if the JSON value is an unsigned + integer number. This excludes floating-point and signed integer values. + + @return `true` if type is an unsigned integer number, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_number_unsigned()` for all + JSON types.,is_number_unsigned} + + @sa @ref is_number() -- check if value is a number + @sa @ref is_number_integer() -- check if value is an integer or unsigned + integer number + @sa @ref is_number_float() -- check if value is a floating-point number + + @since version 2.0.0 + */ + constexpr bool is_number_unsigned() const noexcept + { + return (m_type == value_t::number_unsigned); + } + + /*! + @brief return whether value is a floating-point number + + This function returns true if and only if the JSON value is a + floating-point number. This excludes signed and unsigned integer values. + + @return `true` if type is a floating-point number, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_number_float()` for all + JSON types.,is_number_float} + + @sa @ref is_number() -- check if value is number + @sa @ref is_number_integer() -- check if value is an integer number + @sa @ref is_number_unsigned() -- check if value is an unsigned integer + number + + @since version 1.0.0 + */ + constexpr bool is_number_float() const noexcept + { + return (m_type == value_t::number_float); + } + + /*! + @brief return whether value is an object + + This function returns true if and only if the JSON value is an object. + + @return `true` if type is object, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_object()` for all JSON + types.,is_object} + + @since version 1.0.0 + */ + constexpr bool is_object() const noexcept + { + return (m_type == value_t::object); + } + + /*! + @brief return whether value is an array + + This function returns true if and only if the JSON value is an array. + + @return `true` if type is array, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_array()` for all JSON + types.,is_array} + + @since version 1.0.0 + */ + constexpr bool is_array() const noexcept + { + return (m_type == value_t::array); + } + + /*! + @brief return whether value is a string + + This function returns true if and only if the JSON value is a string. + + @return `true` if type is string, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_string()` for all JSON + types.,is_string} + + @since version 1.0.0 + */ + constexpr bool is_string() const noexcept + { + return (m_type == value_t::string); + } + + /*! + @brief return whether value is discarded + + This function returns true if and only if the JSON value was discarded + during parsing with a callback function (see @ref parser_callback_t). + + @note This function will always be `false` for JSON values after parsing. + That is, discarded values can only occur during parsing, but will be + removed when inside a structured value or replaced by null in other cases. + + @return `true` if type is discarded, `false` otherwise. + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies `is_discarded()` for all JSON + types.,is_discarded} + + @since version 1.0.0 + */ + constexpr bool is_discarded() const noexcept + { + return (m_type == value_t::discarded); + } + + /*! + @brief return the type of the JSON value (implicit) + + Implicitly return the type of the JSON value as a value from the @ref + value_t enumeration. + + @return the type of the JSON value + + @complexity Constant. + + @exceptionsafety No-throw guarantee: this member function never throws + exceptions. + + @liveexample{The following code exemplifies the @ref value_t operator for + all JSON types.,operator__value_t} + + @sa @ref type() -- return the type of the JSON value (explicit) + @sa @ref type_name() -- return the type as string + + @since version 1.0.0 + */ + constexpr operator value_t() const noexcept + { + return m_type; + } + + /// @} + + private: + ////////////////// + // value access // + ////////////////// + + /// get a boolean (explicit) + boolean_t get_impl(boolean_t* /*unused*/) const + { + if (JSON_LIKELY(is_boolean())) + { + return m_value.boolean; + } + + JSON_THROW(type_error::create(302, "type must be boolean, but is " + std::string(type_name()))); + } + + /// get a pointer to the value (object) + object_t* get_impl_ptr(object_t* /*unused*/) noexcept + { + return is_object() ? m_value.object : nullptr; + } + + /// get a pointer to the value (object) + constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept + { + return is_object() ? m_value.object : nullptr; + } + + /// get a pointer to the value (array) + array_t* get_impl_ptr(array_t* /*unused*/) noexcept + { + return is_array() ? m_value.array : nullptr; + } + + /// get a pointer to the value (array) + constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept + { + return is_array() ? m_value.array : nullptr; + } + + /// get a pointer to the value (string) + string_t* get_impl_ptr(string_t* /*unused*/) noexcept + { + return is_string() ? m_value.string : nullptr; + } + + /// get a pointer to the value (string) + constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept + { + return is_string() ? m_value.string : nullptr; + } + + /// get a pointer to the value (boolean) + boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept + { + return is_boolean() ? &m_value.boolean : nullptr; + } + + /// get a pointer to the value (boolean) + constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept + { + return is_boolean() ? &m_value.boolean : nullptr; + } + + /// get a pointer to the value (integer number) + number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept + { + return is_number_integer() ? &m_value.number_integer : nullptr; + } + + /// get a pointer to the value (integer number) + constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept + { + return is_number_integer() ? &m_value.number_integer : nullptr; + } + + /// get a pointer to the value (unsigned number) + number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept + { + return is_number_unsigned() ? &m_value.number_unsigned : nullptr; + } + + /// get a pointer to the value (unsigned number) + constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept + { + return is_number_unsigned() ? &m_value.number_unsigned : nullptr; + } + + /// get a pointer to the value (floating-point number) + number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept + { + return is_number_float() ? &m_value.number_float : nullptr; + } + + /// get a pointer to the value (floating-point number) + constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept + { + return is_number_float() ? &m_value.number_float : nullptr; + } + + /*! + @brief helper function to implement get_ref() + + This function helps to implement get_ref() without code duplication for + const and non-const overloads + + @tparam ThisType will be deduced as `basic_json` or `const basic_json` + + @throw type_error.303 if ReferenceType does not match underlying value + type of the current JSON + */ + template<typename ReferenceType, typename ThisType> + static ReferenceType get_ref_impl(ThisType& obj) + { + // delegate the call to get_ptr<>() + auto ptr = obj.template get_ptr<typename std::add_pointer<ReferenceType>::type>(); + + if (JSON_LIKELY(ptr != nullptr)) + { + return *ptr; + } + + JSON_THROW(type_error::create(303, "incompatible ReferenceType for get_ref, actual type is " + std::string(obj.type_name()))); + } + + public: + /// @name value access + /// Direct access to the stored value of a JSON value. + /// @{ + + /*! + @brief get special-case overload + + This overloads avoids a lot of template boilerplate, it can be seen as the + identity method + + @tparam BasicJsonType == @ref basic_json + + @return a copy of *this + + @complexity Constant. + + @since version 2.1.0 + */ + template<typename BasicJsonType, detail::enable_if_t< + std::is_same<typename std::remove_const<BasicJsonType>::type, basic_json_t>::value, + int> = 0> + basic_json get() const + { + return *this; + } + + /*! + @brief get special-case overload + + This overloads converts the current @ref basic_json in a different + @ref basic_json type + + @tparam BasicJsonType == @ref basic_json + + @return a copy of *this, converted into @tparam BasicJsonType + + @complexity Depending on the implementation of the called `from_json()` + method. + + @since version 3.1.2 + */ + template<typename BasicJsonType, detail::enable_if_t< + not std::is_same<BasicJsonType, basic_json>::value and + detail::is_basic_json<BasicJsonType>::value, int> = 0> + BasicJsonType get() const + { + return *this; + } + + /*! + @brief get a value (explicit) + + Explicit type conversion between the JSON value and a compatible value + which is [CopyConstructible](https://en.cppreference.com/w/cpp/named_req/CopyConstructible) + and [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible). + The value is converted by calling the @ref json_serializer<ValueType> + `from_json()` method. + + The function is equivalent to executing + @code {.cpp} + ValueType ret; + JSONSerializer<ValueType>::from_json(*this, ret); + return ret; + @endcode + + This overloads is chosen if: + - @a ValueType is not @ref basic_json, + - @ref json_serializer<ValueType> has a `from_json()` method of the form + `void from_json(const basic_json&, ValueType&)`, and + - @ref json_serializer<ValueType> does not have a `from_json()` method of + the form `ValueType from_json(const basic_json&)` + + @tparam ValueTypeCV the provided value type + @tparam ValueType the returned value type + + @return copy of the JSON value, converted to @a ValueType + + @throw what @ref json_serializer<ValueType> `from_json()` method throws + + @liveexample{The example below shows several conversions from JSON values + to other types. There a few things to note: (1) Floating-point numbers can + be converted to integers\, (2) A JSON array can be converted to a standard + `std::vector<short>`\, (3) A JSON object can be converted to C++ + associative containers such as `std::unordered_map<std::string\, + json>`.,get__ValueType_const} + + @since version 2.1.0 + */ + template<typename ValueTypeCV, typename ValueType = detail::uncvref_t<ValueTypeCV>, + detail::enable_if_t < + not detail::is_basic_json<ValueType>::value and + detail::has_from_json<basic_json_t, ValueType>::value and + not detail::has_non_default_from_json<basic_json_t, ValueType>::value, + int> = 0> + ValueType get() const noexcept(noexcept( + JSONSerializer<ValueType>::from_json(std::declval<const basic_json_t&>(), std::declval<ValueType&>()))) + { + // we cannot static_assert on ValueTypeCV being non-const, because + // there is support for get<const basic_json_t>(), which is why we + // still need the uncvref + static_assert(not std::is_reference<ValueTypeCV>::value, + "get() cannot be used with reference types, you might want to use get_ref()"); + static_assert(std::is_default_constructible<ValueType>::value, + "types must be DefaultConstructible when used with get()"); + + ValueType ret; + JSONSerializer<ValueType>::from_json(*this, ret); + return ret; + } + + /*! + @brief get a value (explicit); special case + + Explicit type conversion between the JSON value and a compatible value + which is **not** [CopyConstructible](https://en.cppreference.com/w/cpp/named_req/CopyConstructible) + and **not** [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible). + The value is converted by calling the @ref json_serializer<ValueType> + `from_json()` method. + + The function is equivalent to executing + @code {.cpp} + return JSONSerializer<ValueTypeCV>::from_json(*this); + @endcode + + This overloads is chosen if: + - @a ValueType is not @ref basic_json and + - @ref json_serializer<ValueType> has a `from_json()` method of the form + `ValueType from_json(const basic_json&)` + + @note If @ref json_serializer<ValueType> has both overloads of + `from_json()`, this one is chosen. + + @tparam ValueTypeCV the provided value type + @tparam ValueType the returned value type + + @return copy of the JSON value, converted to @a ValueType + + @throw what @ref json_serializer<ValueType> `from_json()` method throws + + @since version 2.1.0 + */ + template<typename ValueTypeCV, typename ValueType = detail::uncvref_t<ValueTypeCV>, + detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and + detail::has_non_default_from_json<basic_json_t, ValueType>::value, + int> = 0> + ValueType get() const noexcept(noexcept( + JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>()))) + { + static_assert(not std::is_reference<ValueTypeCV>::value, + "get() cannot be used with reference types, you might want to use get_ref()"); + return JSONSerializer<ValueTypeCV>::from_json(*this); + } + + /*! + @brief get a pointer value (explicit) + + Explicit pointer access to the internally stored JSON value. No copies are + made. + + @warning The pointer becomes invalid if the underlying JSON object + changes. + + @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref + object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, + @ref number_unsigned_t, or @ref number_float_t. + + @return pointer to the internally stored JSON value if the requested + pointer type @a PointerType fits to the JSON value; `nullptr` otherwise + + @complexity Constant. + + @liveexample{The example below shows how pointers to internal values of a + JSON value can be requested. Note that no type conversions are made and a + `nullptr` is returned if the value and the requested pointer type does not + match.,get__PointerType} + + @sa @ref get_ptr() for explicit pointer-member access + + @since version 1.0.0 + */ + template<typename PointerType, typename std::enable_if< + std::is_pointer<PointerType>::value, int>::type = 0> + PointerType get() noexcept + { + // delegate the call to get_ptr + return get_ptr<PointerType>(); + } + + /*! + @brief get a pointer value (explicit) + @copydoc get() + */ + template<typename PointerType, typename std::enable_if< + std::is_pointer<PointerType>::value, int>::type = 0> + constexpr const PointerType get() const noexcept + { + // delegate the call to get_ptr + return get_ptr<PointerType>(); + } + + /*! + @brief get a pointer value (implicit) + + Implicit pointer access to the internally stored JSON value. No copies are + made. + + @warning Writing data to the pointee of the result yields an undefined + state. + + @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref + object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, + @ref number_unsigned_t, or @ref number_float_t. Enforced by a static + assertion. + + @return pointer to the internally stored JSON value if the requested + pointer type @a PointerType fits to the JSON value; `nullptr` otherwise + + @complexity Constant. + + @liveexample{The example below shows how pointers to internal values of a + JSON value can be requested. Note that no type conversions are made and a + `nullptr` is returned if the value and the requested pointer type does not + match.,get_ptr} + + @since version 1.0.0 + */ + template<typename PointerType, typename std::enable_if< + std::is_pointer<PointerType>::value, int>::type = 0> + PointerType get_ptr() noexcept + { + // get the type of the PointerType (remove pointer and const) + using pointee_t = typename std::remove_const<typename + std::remove_pointer<typename + std::remove_const<PointerType>::type>::type>::type; + // make sure the type matches the allowed types + static_assert( + std::is_same<object_t, pointee_t>::value + or std::is_same<array_t, pointee_t>::value + or std::is_same<string_t, pointee_t>::value + or std::is_same<boolean_t, pointee_t>::value + or std::is_same<number_integer_t, pointee_t>::value + or std::is_same<number_unsigned_t, pointee_t>::value + or std::is_same<number_float_t, pointee_t>::value + , "incompatible pointer type"); + + // delegate the call to get_impl_ptr<>() + return get_impl_ptr(static_cast<PointerType>(nullptr)); + } + + /*! + @brief get a pointer value (implicit) + @copydoc get_ptr() + */ + template<typename PointerType, typename std::enable_if< + std::is_pointer<PointerType>::value and + std::is_const<typename std::remove_pointer<PointerType>::type>::value, int>::type = 0> + constexpr const PointerType get_ptr() const noexcept + { + // get the type of the PointerType (remove pointer and const) + using pointee_t = typename std::remove_const<typename + std::remove_pointer<typename + std::remove_const<PointerType>::type>::type>::type; + // make sure the type matches the allowed types + static_assert( + std::is_same<object_t, pointee_t>::value + or std::is_same<array_t, pointee_t>::value + or std::is_same<string_t, pointee_t>::value + or std::is_same<boolean_t, pointee_t>::value + or std::is_same<number_integer_t, pointee_t>::value + or std::is_same<number_unsigned_t, pointee_t>::value + or std::is_same<number_float_t, pointee_t>::value + , "incompatible pointer type"); + + // delegate the call to get_impl_ptr<>() const + return get_impl_ptr(static_cast<PointerType>(nullptr)); + } + + /*! + @brief get a reference value (implicit) + + Implicit reference access to the internally stored JSON value. No copies + are made. + + @warning Writing data to the referee of the result yields an undefined + state. + + @tparam ReferenceType reference type; must be a reference to @ref array_t, + @ref object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, or + @ref number_float_t. Enforced by static assertion. + + @return reference to the internally stored JSON value if the requested + reference type @a ReferenceType fits to the JSON value; throws + type_error.303 otherwise + + @throw type_error.303 in case passed type @a ReferenceType is incompatible + with the stored JSON value; see example below + + @complexity Constant. + + @liveexample{The example shows several calls to `get_ref()`.,get_ref} + + @since version 1.1.0 + */ + template<typename ReferenceType, typename std::enable_if< + std::is_reference<ReferenceType>::value, int>::type = 0> + ReferenceType get_ref() + { + // delegate call to get_ref_impl + return get_ref_impl<ReferenceType>(*this); + } + + /*! + @brief get a reference value (implicit) + @copydoc get_ref() + */ + template<typename ReferenceType, typename std::enable_if< + std::is_reference<ReferenceType>::value and + std::is_const<typename std::remove_reference<ReferenceType>::type>::value, int>::type = 0> + ReferenceType get_ref() const + { + // delegate call to get_ref_impl + return get_ref_impl<ReferenceType>(*this); + } + + /*! + @brief get a value (implicit) + + Implicit type conversion between the JSON value and a compatible value. + The call is realized by calling @ref get() const. + + @tparam ValueType non-pointer type compatible to the JSON value, for + instance `int` for JSON integer numbers, `bool` for JSON booleans, or + `std::vector` types for JSON arrays. The character type of @ref string_t + as well as an initializer list of this type is excluded to avoid + ambiguities as these types implicitly convert to `std::string`. + + @return copy of the JSON value, converted to type @a ValueType + + @throw type_error.302 in case passed type @a ValueType is incompatible + to the JSON value type (e.g., the JSON value is of type boolean, but a + string is requested); see example below + + @complexity Linear in the size of the JSON value. + + @liveexample{The example below shows several conversions from JSON values + to other types. There a few things to note: (1) Floating-point numbers can + be converted to integers\, (2) A JSON array can be converted to a standard + `std::vector<short>`\, (3) A JSON object can be converted to C++ + associative containers such as `std::unordered_map<std::string\, + json>`.,operator__ValueType} + + @since version 1.0.0 + */ + template < typename ValueType, typename std::enable_if < + not std::is_pointer<ValueType>::value and + not std::is_same<ValueType, detail::json_ref<basic_json>>::value and + not std::is_same<ValueType, typename string_t::value_type>::value and + not detail::is_basic_json<ValueType>::value +#ifndef _MSC_VER // fix for issue #167 operator<< ambiguity under VS2015 + and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value +#if defined(JSON_HAS_CPP_17) && _MSC_VER <= 1914 + and not std::is_same<ValueType, typename std::string_view>::value +#endif +#endif + , int >::type = 0 > + operator ValueType() const + { + // delegate the call to get<>() const + return get<ValueType>(); + } + + /// @} + + + //////////////////// + // element access // + //////////////////// + + /// @name element access + /// Access to the JSON value. + /// @{ + + /*! + @brief access specified array element with bounds checking + + Returns a reference to the element at specified location @a idx, with + bounds checking. + + @param[in] idx index of the element to access + + @return reference to the element at index @a idx + + @throw type_error.304 if the JSON value is not an array; in this case, + calling `at` with an index makes no sense. See example below. + @throw out_of_range.401 if the index @a idx is out of range of the array; + that is, `idx >= size()`. See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 1.0.0 + + @liveexample{The example below shows how array elements can be read and + written using `at()`. It also demonstrates the different exceptions that + can be thrown.,at__size_type} + */ + reference at(size_type idx) + { + // at only works for arrays + if (JSON_LIKELY(is_array())) + { + JSON_TRY + { + return m_value.array->at(idx); + } + JSON_CATCH (std::out_of_range&) + { + // create better exception explanation + JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); + } + } + else + { + JSON_THROW(type_error::create(304, "cannot use at() with " + std::string(type_name()))); + } + } + + /*! + @brief access specified array element with bounds checking + + Returns a const reference to the element at specified location @a idx, + with bounds checking. + + @param[in] idx index of the element to access + + @return const reference to the element at index @a idx + + @throw type_error.304 if the JSON value is not an array; in this case, + calling `at` with an index makes no sense. See example below. + @throw out_of_range.401 if the index @a idx is out of range of the array; + that is, `idx >= size()`. See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 1.0.0 + + @liveexample{The example below shows how array elements can be read using + `at()`. It also demonstrates the different exceptions that can be thrown., + at__size_type_const} + */ + const_reference at(size_type idx) const + { + // at only works for arrays + if (JSON_LIKELY(is_array())) + { + JSON_TRY + { + return m_value.array->at(idx); + } + JSON_CATCH (std::out_of_range&) + { + // create better exception explanation + JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); + } + } + else + { + JSON_THROW(type_error::create(304, "cannot use at() with " + std::string(type_name()))); + } + } + + /*! + @brief access specified object element with bounds checking + + Returns a reference to the element at with specified key @a key, with + bounds checking. + + @param[in] key key of the element to access + + @return reference to the element at key @a key + + @throw type_error.304 if the JSON value is not an object; in this case, + calling `at` with a key makes no sense. See example below. + @throw out_of_range.403 if the key @a key is is not stored in the object; + that is, `find(key) == end()`. See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Logarithmic in the size of the container. + + @sa @ref operator[](const typename object_t::key_type&) for unchecked + access by reference + @sa @ref value() for access by value with a default value + + @since version 1.0.0 + + @liveexample{The example below shows how object elements can be read and + written using `at()`. It also demonstrates the different exceptions that + can be thrown.,at__object_t_key_type} + */ + reference at(const typename object_t::key_type& key) + { + // at only works for objects + if (JSON_LIKELY(is_object())) + { + JSON_TRY + { + return m_value.object->at(key); + } + JSON_CATCH (std::out_of_range&) + { + // create better exception explanation + JSON_THROW(out_of_range::create(403, "key '" + key + "' not found")); + } + } + else + { + JSON_THROW(type_error::create(304, "cannot use at() with " + std::string(type_name()))); + } + } + + /*! + @brief access specified object element with bounds checking + + Returns a const reference to the element at with specified key @a key, + with bounds checking. + + @param[in] key key of the element to access + + @return const reference to the element at key @a key + + @throw type_error.304 if the JSON value is not an object; in this case, + calling `at` with a key makes no sense. See example below. + @throw out_of_range.403 if the key @a key is is not stored in the object; + that is, `find(key) == end()`. See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Logarithmic in the size of the container. + + @sa @ref operator[](const typename object_t::key_type&) for unchecked + access by reference + @sa @ref value() for access by value with a default value + + @since version 1.0.0 + + @liveexample{The example below shows how object elements can be read using + `at()`. It also demonstrates the different exceptions that can be thrown., + at__object_t_key_type_const} + */ + const_reference at(const typename object_t::key_type& key) const + { + // at only works for objects + if (JSON_LIKELY(is_object())) + { + JSON_TRY + { + return m_value.object->at(key); + } + JSON_CATCH (std::out_of_range&) + { + // create better exception explanation + JSON_THROW(out_of_range::create(403, "key '" + key + "' not found")); + } + } + else + { + JSON_THROW(type_error::create(304, "cannot use at() with " + std::string(type_name()))); + } + } + + /*! + @brief access specified array element + + Returns a reference to the element at specified location @a idx. + + @note If @a idx is beyond the range of the array (i.e., `idx >= size()`), + then the array is silently filled up with `null` values to make `idx` a + valid reference to the last stored element. + + @param[in] idx index of the element to access + + @return reference to the element at index @a idx + + @throw type_error.305 if the JSON value is not an array or null; in that + cases, using the [] operator with an index makes no sense. + + @complexity Constant if @a idx is in the range of the array. Otherwise + linear in `idx - size()`. + + @liveexample{The example below shows how array elements can be read and + written using `[]` operator. Note the addition of `null` + values.,operatorarray__size_type} + + @since version 1.0.0 + */ + reference operator[](size_type idx) + { + // implicitly convert null value to an empty array + if (is_null()) + { + m_type = value_t::array; + m_value.array = create<array_t>(); + assert_invariant(); + } + + // operator[] only works for arrays + if (JSON_LIKELY(is_array())) + { + // fill up array with null values if given idx is outside range + if (idx >= m_value.array->size()) + { + m_value.array->insert(m_value.array->end(), + idx - m_value.array->size() + 1, + basic_json()); + } + + return m_value.array->operator[](idx); + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name()))); + } + + /*! + @brief access specified array element + + Returns a const reference to the element at specified location @a idx. + + @param[in] idx index of the element to access + + @return const reference to the element at index @a idx + + @throw type_error.305 if the JSON value is not an array; in that case, + using the [] operator with an index makes no sense. + + @complexity Constant. + + @liveexample{The example below shows how array elements can be read using + the `[]` operator.,operatorarray__size_type_const} + + @since version 1.0.0 + */ + const_reference operator[](size_type idx) const + { + // const operator[] only works for arrays + if (JSON_LIKELY(is_array())) + { + return m_value.array->operator[](idx); + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name()))); + } + + /*! + @brief access specified object element + + Returns a reference to the element at with specified key @a key. + + @note If @a key is not found in the object, then it is silently added to + the object and filled with a `null` value to make `key` a valid reference. + In case the value was `null` before, it is converted to an object. + + @param[in] key key of the element to access + + @return reference to the element at key @a key + + @throw type_error.305 if the JSON value is not an object or null; in that + cases, using the [] operator with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be read and + written using the `[]` operator.,operatorarray__key_type} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref value() for access by value with a default value + + @since version 1.0.0 + */ + reference operator[](const typename object_t::key_type& key) + { + // implicitly convert null value to an empty object + if (is_null()) + { + m_type = value_t::object; + m_value.object = create<object_t>(); + assert_invariant(); + } + + // operator[] only works for objects + if (JSON_LIKELY(is_object())) + { + return m_value.object->operator[](key); + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name()))); + } + + /*! + @brief read-only access specified object element + + Returns a const reference to the element at with specified key @a key. No + bounds checking is performed. + + @warning If the element with key @a key does not exist, the behavior is + undefined. + + @param[in] key key of the element to access + + @return const reference to the element at key @a key + + @pre The element with key @a key must exist. **This precondition is + enforced with an assertion.** + + @throw type_error.305 if the JSON value is not an object; in that case, + using the [] operator with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be read using + the `[]` operator.,operatorarray__key_type_const} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref value() for access by value with a default value + + @since version 1.0.0 + */ + const_reference operator[](const typename object_t::key_type& key) const + { + // const operator[] only works for objects + if (JSON_LIKELY(is_object())) + { + assert(m_value.object->find(key) != m_value.object->end()); + return m_value.object->find(key)->second; + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name()))); + } + + /*! + @brief access specified object element + + Returns a reference to the element at with specified key @a key. + + @note If @a key is not found in the object, then it is silently added to + the object and filled with a `null` value to make `key` a valid reference. + In case the value was `null` before, it is converted to an object. + + @param[in] key key of the element to access + + @return reference to the element at key @a key + + @throw type_error.305 if the JSON value is not an object or null; in that + cases, using the [] operator with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be read and + written using the `[]` operator.,operatorarray__key_type} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref value() for access by value with a default value + + @since version 1.1.0 + */ + template<typename T> + reference operator[](T* key) + { + // implicitly convert null to object + if (is_null()) + { + m_type = value_t::object; + m_value = value_t::object; + assert_invariant(); + } + + // at only works for objects + if (JSON_LIKELY(is_object())) + { + return m_value.object->operator[](key); + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name()))); + } + + /*! + @brief read-only access specified object element + + Returns a const reference to the element at with specified key @a key. No + bounds checking is performed. + + @warning If the element with key @a key does not exist, the behavior is + undefined. + + @param[in] key key of the element to access + + @return const reference to the element at key @a key + + @pre The element with key @a key must exist. **This precondition is + enforced with an assertion.** + + @throw type_error.305 if the JSON value is not an object; in that case, + using the [] operator with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be read using + the `[]` operator.,operatorarray__key_type_const} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref value() for access by value with a default value + + @since version 1.1.0 + */ + template<typename T> + const_reference operator[](T* key) const + { + // at only works for objects + if (JSON_LIKELY(is_object())) + { + assert(m_value.object->find(key) != m_value.object->end()); + return m_value.object->find(key)->second; + } + + JSON_THROW(type_error::create(305, "cannot use operator[] with " + std::string(type_name()))); + } + + /*! + @brief access specified object element with default value + + Returns either a copy of an object's element at the specified key @a key + or a given default value if no element with key @a key exists. + + The function is basically equivalent to executing + @code {.cpp} + try { + return at(key); + } catch(out_of_range) { + return default_value; + } + @endcode + + @note Unlike @ref at(const typename object_t::key_type&), this function + does not throw if the given key @a key was not found. + + @note Unlike @ref operator[](const typename object_t::key_type& key), this + function does not implicitly add an element to the position defined by @a + key. This function is furthermore also applicable to const objects. + + @param[in] key key of the element to access + @param[in] default_value the value to return if @a key is not found + + @tparam ValueType type compatible to JSON values, for instance `int` for + JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for + JSON arrays. Note the type of the expected value at @a key and the default + value @a default_value must be compatible. + + @return copy of the element at key @a key or @a default_value if @a key + is not found + + @throw type_error.306 if the JSON value is not an object; in that case, + using `value()` with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be queried + with a default value.,basic_json__value} + + @sa @ref at(const typename object_t::key_type&) for access by reference + with range checking + @sa @ref operator[](const typename object_t::key_type&) for unchecked + access by reference + + @since version 1.0.0 + */ + template<class ValueType, typename std::enable_if< + std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0> + ValueType value(const typename object_t::key_type& key, const ValueType& default_value) const + { + // at only works for objects + if (JSON_LIKELY(is_object())) + { + // if key is found, return value and given default value otherwise + const auto it = find(key); + if (it != end()) + { + return *it; + } + + return default_value; + } + + JSON_THROW(type_error::create(306, "cannot use value() with " + std::string(type_name()))); + } + + /*! + @brief overload for a default value of type const char* + @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const + */ + string_t value(const typename object_t::key_type& key, const char* default_value) const + { + return value(key, string_t(default_value)); + } + + /*! + @brief access specified object element via JSON Pointer with default value + + Returns either a copy of an object's element at the specified key @a key + or a given default value if no element with key @a key exists. + + The function is basically equivalent to executing + @code {.cpp} + try { + return at(ptr); + } catch(out_of_range) { + return default_value; + } + @endcode + + @note Unlike @ref at(const json_pointer&), this function does not throw + if the given key @a key was not found. + + @param[in] ptr a JSON pointer to the element to access + @param[in] default_value the value to return if @a ptr found no value + + @tparam ValueType type compatible to JSON values, for instance `int` for + JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for + JSON arrays. Note the type of the expected value at @a key and the default + value @a default_value must be compatible. + + @return copy of the element at key @a key or @a default_value if @a key + is not found + + @throw type_error.306 if the JSON value is not an object; in that case, + using `value()` with a key makes no sense. + + @complexity Logarithmic in the size of the container. + + @liveexample{The example below shows how object elements can be queried + with a default value.,basic_json__value_ptr} + + @sa @ref operator[](const json_pointer&) for unchecked access by reference + + @since version 2.0.2 + */ + template<class ValueType, typename std::enable_if< + std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0> + ValueType value(const json_pointer& ptr, const ValueType& default_value) const + { + // at only works for objects + if (JSON_LIKELY(is_object())) + { + // if pointer resolves a value, return it or use default value + JSON_TRY + { + return ptr.get_checked(this); + } + JSON_CATCH (out_of_range&) + { + return default_value; + } + } + + JSON_THROW(type_error::create(306, "cannot use value() with " + std::string(type_name()))); + } + + /*! + @brief overload for a default value of type const char* + @copydoc basic_json::value(const json_pointer&, ValueType) const + */ + string_t value(const json_pointer& ptr, const char* default_value) const + { + return value(ptr, string_t(default_value)); + } + + /*! + @brief access the first element + + Returns a reference to the first element in the container. For a JSON + container `c`, the expression `c.front()` is equivalent to `*c.begin()`. + + @return In case of a structured type (array or object), a reference to the + first element is returned. In case of number, string, or boolean values, a + reference to the value is returned. + + @complexity Constant. + + @pre The JSON value must not be `null` (would throw `std::out_of_range`) + or an empty array or object (undefined behavior, **guarded by + assertions**). + @post The JSON value remains unchanged. + + @throw invalid_iterator.214 when called on `null` value + + @liveexample{The following code shows an example for `front()`.,front} + + @sa @ref back() -- access the last element + + @since version 1.0.0 + */ + reference front() + { + return *begin(); + } + + /*! + @copydoc basic_json::front() + */ + const_reference front() const + { + return *cbegin(); + } + + /*! + @brief access the last element + + Returns a reference to the last element in the container. For a JSON + container `c`, the expression `c.back()` is equivalent to + @code {.cpp} + auto tmp = c.end(); + --tmp; + return *tmp; + @endcode + + @return In case of a structured type (array or object), a reference to the + last element is returned. In case of number, string, or boolean values, a + reference to the value is returned. + + @complexity Constant. + + @pre The JSON value must not be `null` (would throw `std::out_of_range`) + or an empty array or object (undefined behavior, **guarded by + assertions**). + @post The JSON value remains unchanged. + + @throw invalid_iterator.214 when called on a `null` value. See example + below. + + @liveexample{The following code shows an example for `back()`.,back} + + @sa @ref front() -- access the first element + + @since version 1.0.0 + */ + reference back() + { + auto tmp = end(); + --tmp; + return *tmp; + } + + /*! + @copydoc basic_json::back() + */ + const_reference back() const + { + auto tmp = cend(); + --tmp; + return *tmp; + } + + /*! + @brief remove element given an iterator + + Removes the element specified by iterator @a pos. The iterator @a pos must + be valid and dereferenceable. Thus the `end()` iterator (which is valid, + but is not dereferenceable) cannot be used as a value for @a pos. + + If called on a primitive type other than `null`, the resulting JSON value + will be `null`. + + @param[in] pos iterator to the element to remove + @return Iterator following the last removed element. If the iterator @a + pos refers to the last element, the `end()` iterator is returned. + + @tparam IteratorType an @ref iterator or @ref const_iterator + + @post Invalidates iterators and references at or after the point of the + erase, including the `end()` iterator. + + @throw type_error.307 if called on a `null` value; example: `"cannot use + erase() with null"` + @throw invalid_iterator.202 if called on an iterator which does not belong + to the current JSON value; example: `"iterator does not fit current + value"` + @throw invalid_iterator.205 if called on a primitive type with invalid + iterator (i.e., any iterator which is not `begin()`); example: `"iterator + out of range"` + + @complexity The complexity depends on the type: + - objects: amortized constant + - arrays: linear in distance between @a pos and the end of the container + - strings: linear in the length of the string + - other types: constant + + @liveexample{The example shows the result of `erase()` for different JSON + types.,erase__IteratorType} + + @sa @ref erase(IteratorType, IteratorType) -- removes the elements in + the given range + @sa @ref erase(const typename object_t::key_type&) -- removes the element + from an object at the given key + @sa @ref erase(const size_type) -- removes the element from an array at + the given index + + @since version 1.0.0 + */ + template<class IteratorType, typename std::enable_if< + std::is_same<IteratorType, typename basic_json_t::iterator>::value or + std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type + = 0> + IteratorType erase(IteratorType pos) + { + // make sure iterator fits the current value + if (JSON_UNLIKELY(this != pos.m_object)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + IteratorType result = end(); + + switch (m_type) + { + case value_t::boolean: + case value_t::number_float: + case value_t::number_integer: + case value_t::number_unsigned: + case value_t::string: + { + if (JSON_UNLIKELY(not pos.m_it.primitive_iterator.is_begin())) + { + JSON_THROW(invalid_iterator::create(205, "iterator out of range")); + } + + if (is_string()) + { + AllocatorType<string_t> alloc; + std::allocator_traits<decltype(alloc)>::destroy(alloc, m_value.string); + std::allocator_traits<decltype(alloc)>::deallocate(alloc, m_value.string, 1); + m_value.string = nullptr; + } + + m_type = value_t::null; + assert_invariant(); + break; + } + + case value_t::object: + { + result.m_it.object_iterator = m_value.object->erase(pos.m_it.object_iterator); + break; + } + + case value_t::array: + { + result.m_it.array_iterator = m_value.array->erase(pos.m_it.array_iterator); + break; + } + + default: + JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name()))); + } + + return result; + } + + /*! + @brief remove elements given an iterator range + + Removes the element specified by the range `[first; last)`. The iterator + @a first does not need to be dereferenceable if `first == last`: erasing + an empty range is a no-op. + + If called on a primitive type other than `null`, the resulting JSON value + will be `null`. + + @param[in] first iterator to the beginning of the range to remove + @param[in] last iterator past the end of the range to remove + @return Iterator following the last removed element. If the iterator @a + second refers to the last element, the `end()` iterator is returned. + + @tparam IteratorType an @ref iterator or @ref const_iterator + + @post Invalidates iterators and references at or after the point of the + erase, including the `end()` iterator. + + @throw type_error.307 if called on a `null` value; example: `"cannot use + erase() with null"` + @throw invalid_iterator.203 if called on iterators which does not belong + to the current JSON value; example: `"iterators do not fit current value"` + @throw invalid_iterator.204 if called on a primitive type with invalid + iterators (i.e., if `first != begin()` and `last != end()`); example: + `"iterators out of range"` + + @complexity The complexity depends on the type: + - objects: `log(size()) + std::distance(first, last)` + - arrays: linear in the distance between @a first and @a last, plus linear + in the distance between @a last and end of the container + - strings: linear in the length of the string + - other types: constant + + @liveexample{The example shows the result of `erase()` for different JSON + types.,erase__IteratorType_IteratorType} + + @sa @ref erase(IteratorType) -- removes the element at a given position + @sa @ref erase(const typename object_t::key_type&) -- removes the element + from an object at the given key + @sa @ref erase(const size_type) -- removes the element from an array at + the given index + + @since version 1.0.0 + */ + template<class IteratorType, typename std::enable_if< + std::is_same<IteratorType, typename basic_json_t::iterator>::value or + std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type + = 0> + IteratorType erase(IteratorType first, IteratorType last) + { + // make sure iterator fits the current value + if (JSON_UNLIKELY(this != first.m_object or this != last.m_object)) + { + JSON_THROW(invalid_iterator::create(203, "iterators do not fit current value")); + } + + IteratorType result = end(); + + switch (m_type) + { + case value_t::boolean: + case value_t::number_float: + case value_t::number_integer: + case value_t::number_unsigned: + case value_t::string: + { + if (JSON_LIKELY(not first.m_it.primitive_iterator.is_begin() + or not last.m_it.primitive_iterator.is_end())) + { + JSON_THROW(invalid_iterator::create(204, "iterators out of range")); + } + + if (is_string()) + { + AllocatorType<string_t> alloc; + std::allocator_traits<decltype(alloc)>::destroy(alloc, m_value.string); + std::allocator_traits<decltype(alloc)>::deallocate(alloc, m_value.string, 1); + m_value.string = nullptr; + } + + m_type = value_t::null; + assert_invariant(); + break; + } + + case value_t::object: + { + result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator, + last.m_it.object_iterator); + break; + } + + case value_t::array: + { + result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator, + last.m_it.array_iterator); + break; + } + + default: + JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name()))); + } + + return result; + } + + /*! + @brief remove element from a JSON object given a key + + Removes elements from a JSON object with the key value @a key. + + @param[in] key value of the elements to remove + + @return Number of elements removed. If @a ObjectType is the default + `std::map` type, the return value will always be `0` (@a key was not + found) or `1` (@a key was found). + + @post References and iterators to the erased elements are invalidated. + Other references and iterators are not affected. + + @throw type_error.307 when called on a type other than JSON object; + example: `"cannot use erase() with null"` + + @complexity `log(size()) + count(key)` + + @liveexample{The example shows the effect of `erase()`.,erase__key_type} + + @sa @ref erase(IteratorType) -- removes the element at a given position + @sa @ref erase(IteratorType, IteratorType) -- removes the elements in + the given range + @sa @ref erase(const size_type) -- removes the element from an array at + the given index + + @since version 1.0.0 + */ + size_type erase(const typename object_t::key_type& key) + { + // this erase only works for objects + if (JSON_LIKELY(is_object())) + { + return m_value.object->erase(key); + } + + JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name()))); + } + + /*! + @brief remove element from a JSON array given an index + + Removes element from a JSON array at the index @a idx. + + @param[in] idx index of the element to remove + + @throw type_error.307 when called on a type other than JSON object; + example: `"cannot use erase() with null"` + @throw out_of_range.401 when `idx >= size()`; example: `"array index 17 + is out of range"` + + @complexity Linear in distance between @a idx and the end of the container. + + @liveexample{The example shows the effect of `erase()`.,erase__size_type} + + @sa @ref erase(IteratorType) -- removes the element at a given position + @sa @ref erase(IteratorType, IteratorType) -- removes the elements in + the given range + @sa @ref erase(const typename object_t::key_type&) -- removes the element + from an object at the given key + + @since version 1.0.0 + */ + void erase(const size_type idx) + { + // this erase only works for arrays + if (JSON_LIKELY(is_array())) + { + if (JSON_UNLIKELY(idx >= size())) + { + JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); + } + + m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx)); + } + else + { + JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name()))); + } + } + + /// @} + + + //////////// + // lookup // + //////////// + + /// @name lookup + /// @{ + + /*! + @brief find an element in a JSON object + + Finds an element in a JSON object with key equivalent to @a key. If the + element is not found or the JSON value is not an object, end() is + returned. + + @note This method always returns @ref end() when executed on a JSON type + that is not an object. + + @param[in] key key value of the element to search for. + + @return Iterator to an element with key equivalent to @a key. If no such + element is found or the JSON value is not an object, past-the-end (see + @ref end()) iterator is returned. + + @complexity Logarithmic in the size of the JSON object. + + @liveexample{The example shows how `find()` is used.,find__key_type} + + @since version 1.0.0 + */ + template<typename KeyT> + iterator find(KeyT&& key) + { + auto result = end(); + + if (is_object()) + { + result.m_it.object_iterator = m_value.object->find(std::forward<KeyT>(key)); + } + + return result; + } + + /*! + @brief find an element in a JSON object + @copydoc find(KeyT&&) + */ + template<typename KeyT> + const_iterator find(KeyT&& key) const + { + auto result = cend(); + + if (is_object()) + { + result.m_it.object_iterator = m_value.object->find(std::forward<KeyT>(key)); + } + + return result; + } + + /*! + @brief returns the number of occurrences of a key in a JSON object + + Returns the number of elements with key @a key. If ObjectType is the + default `std::map` type, the return value will always be `0` (@a key was + not found) or `1` (@a key was found). + + @note This method always returns `0` when executed on a JSON type that is + not an object. + + @param[in] key key value of the element to count + + @return Number of elements with key @a key. If the JSON value is not an + object, the return value will be `0`. + + @complexity Logarithmic in the size of the JSON object. + + @liveexample{The example shows how `count()` is used.,count} + + @since version 1.0.0 + */ + template<typename KeyT> + size_type count(KeyT&& key) const + { + // return 0 for all nonobject types + return is_object() ? m_value.object->count(std::forward<KeyT>(key)) : 0; + } + + /// @} + + + /////////////// + // iterators // + /////////////// + + /// @name iterators + /// @{ + + /*! + @brief returns an iterator to the first element + + Returns an iterator to the first element. + + @image html range-begin-end.svg "Illustration from cppreference.com" + + @return iterator to the first element + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + + @liveexample{The following code shows an example for `begin()`.,begin} + + @sa @ref cbegin() -- returns a const iterator to the beginning + @sa @ref end() -- returns an iterator to the end + @sa @ref cend() -- returns a const iterator to the end + + @since version 1.0.0 + */ + iterator begin() noexcept + { + iterator result(this); + result.set_begin(); + return result; + } + + /*! + @copydoc basic_json::cbegin() + */ + const_iterator begin() const noexcept + { + return cbegin(); + } + + /*! + @brief returns a const iterator to the first element + + Returns a const iterator to the first element. + + @image html range-begin-end.svg "Illustration from cppreference.com" + + @return const iterator to the first element + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of `const_cast<const basic_json&>(*this).begin()`. + + @liveexample{The following code shows an example for `cbegin()`.,cbegin} + + @sa @ref begin() -- returns an iterator to the beginning + @sa @ref end() -- returns an iterator to the end + @sa @ref cend() -- returns a const iterator to the end + + @since version 1.0.0 + */ + const_iterator cbegin() const noexcept + { + const_iterator result(this); + result.set_begin(); + return result; + } + + /*! + @brief returns an iterator to one past the last element + + Returns an iterator to one past the last element. + + @image html range-begin-end.svg "Illustration from cppreference.com" + + @return iterator one past the last element + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + + @liveexample{The following code shows an example for `end()`.,end} + + @sa @ref cend() -- returns a const iterator to the end + @sa @ref begin() -- returns an iterator to the beginning + @sa @ref cbegin() -- returns a const iterator to the beginning + + @since version 1.0.0 + */ + iterator end() noexcept + { + iterator result(this); + result.set_end(); + return result; + } + + /*! + @copydoc basic_json::cend() + */ + const_iterator end() const noexcept + { + return cend(); + } + + /*! + @brief returns a const iterator to one past the last element + + Returns a const iterator to one past the last element. + + @image html range-begin-end.svg "Illustration from cppreference.com" + + @return const iterator one past the last element + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of `const_cast<const basic_json&>(*this).end()`. + + @liveexample{The following code shows an example for `cend()`.,cend} + + @sa @ref end() -- returns an iterator to the end + @sa @ref begin() -- returns an iterator to the beginning + @sa @ref cbegin() -- returns a const iterator to the beginning + + @since version 1.0.0 + */ + const_iterator cend() const noexcept + { + const_iterator result(this); + result.set_end(); + return result; + } + + /*! + @brief returns an iterator to the reverse-beginning + + Returns an iterator to the reverse-beginning; that is, the last element. + + @image html range-rbegin-rend.svg "Illustration from cppreference.com" + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer) + requirements: + - The complexity is constant. + - Has the semantics of `reverse_iterator(end())`. + + @liveexample{The following code shows an example for `rbegin()`.,rbegin} + + @sa @ref crbegin() -- returns a const reverse iterator to the beginning + @sa @ref rend() -- returns a reverse iterator to the end + @sa @ref crend() -- returns a const reverse iterator to the end + + @since version 1.0.0 + */ + reverse_iterator rbegin() noexcept + { + return reverse_iterator(end()); + } + + /*! + @copydoc basic_json::crbegin() + */ + const_reverse_iterator rbegin() const noexcept + { + return crbegin(); + } + + /*! + @brief returns an iterator to the reverse-end + + Returns an iterator to the reverse-end; that is, one before the first + element. + + @image html range-rbegin-rend.svg "Illustration from cppreference.com" + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer) + requirements: + - The complexity is constant. + - Has the semantics of `reverse_iterator(begin())`. + + @liveexample{The following code shows an example for `rend()`.,rend} + + @sa @ref crend() -- returns a const reverse iterator to the end + @sa @ref rbegin() -- returns a reverse iterator to the beginning + @sa @ref crbegin() -- returns a const reverse iterator to the beginning + + @since version 1.0.0 + */ + reverse_iterator rend() noexcept + { + return reverse_iterator(begin()); + } + + /*! + @copydoc basic_json::crend() + */ + const_reverse_iterator rend() const noexcept + { + return crend(); + } + + /*! + @brief returns a const reverse iterator to the last element + + Returns a const iterator to the reverse-beginning; that is, the last + element. + + @image html range-rbegin-rend.svg "Illustration from cppreference.com" + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer) + requirements: + - The complexity is constant. + - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`. + + @liveexample{The following code shows an example for `crbegin()`.,crbegin} + + @sa @ref rbegin() -- returns a reverse iterator to the beginning + @sa @ref rend() -- returns a reverse iterator to the end + @sa @ref crend() -- returns a const reverse iterator to the end + + @since version 1.0.0 + */ + const_reverse_iterator crbegin() const noexcept + { + return const_reverse_iterator(cend()); + } + + /*! + @brief returns a const reverse iterator to one before the first + + Returns a const reverse iterator to the reverse-end; that is, one before + the first element. + + @image html range-rbegin-rend.svg "Illustration from cppreference.com" + + @complexity Constant. + + @requirement This function helps `basic_json` satisfying the + [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer) + requirements: + - The complexity is constant. + - Has the semantics of `const_cast<const basic_json&>(*this).rend()`. + + @liveexample{The following code shows an example for `crend()`.,crend} + + @sa @ref rend() -- returns a reverse iterator to the end + @sa @ref rbegin() -- returns a reverse iterator to the beginning + @sa @ref crbegin() -- returns a const reverse iterator to the beginning + + @since version 1.0.0 + */ + const_reverse_iterator crend() const noexcept + { + return const_reverse_iterator(cbegin()); + } + + public: + /*! + @brief wrapper to access iterator member functions in range-based for + + This function allows to access @ref iterator::key() and @ref + iterator::value() during range-based for loops. In these loops, a + reference to the JSON values is returned, so there is no access to the + underlying iterator. + + For loop without iterator_wrapper: + + @code{cpp} + for (auto it = j_object.begin(); it != j_object.end(); ++it) + { + std::cout << "key: " << it.key() << ", value:" << it.value() << '\n'; + } + @endcode + + Range-based for loop without iterator proxy: + + @code{cpp} + for (auto it : j_object) + { + // "it" is of type json::reference and has no key() member + std::cout << "value: " << it << '\n'; + } + @endcode + + Range-based for loop with iterator proxy: + + @code{cpp} + for (auto it : json::iterator_wrapper(j_object)) + { + std::cout << "key: " << it.key() << ", value:" << it.value() << '\n'; + } + @endcode + + @note When iterating over an array, `key()` will return the index of the + element as string (see example). + + @param[in] ref reference to a JSON value + @return iteration proxy object wrapping @a ref with an interface to use in + range-based for loops + + @liveexample{The following code shows how the wrapper is used,iterator_wrapper} + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @note The name of this function is not yet final and may change in the + future. + + @deprecated This stream operator is deprecated and will be removed in + future 4.0.0 of the library. Please use @ref items() instead; + that is, replace `json::iterator_wrapper(j)` with `j.items()`. + */ + JSON_DEPRECATED + static iteration_proxy<iterator> iterator_wrapper(reference ref) noexcept + { + return ref.items(); + } + + /*! + @copydoc iterator_wrapper(reference) + */ + JSON_DEPRECATED + static iteration_proxy<const_iterator> iterator_wrapper(const_reference ref) noexcept + { + return ref.items(); + } + + /*! + @brief helper to access iterator member functions in range-based for + + This function allows to access @ref iterator::key() and @ref + iterator::value() during range-based for loops. In these loops, a + reference to the JSON values is returned, so there is no access to the + underlying iterator. + + For loop without `items()` function: + + @code{cpp} + for (auto it = j_object.begin(); it != j_object.end(); ++it) + { + std::cout << "key: " << it.key() << ", value:" << it.value() << '\n'; + } + @endcode + + Range-based for loop without `items()` function: + + @code{cpp} + for (auto it : j_object) + { + // "it" is of type json::reference and has no key() member + std::cout << "value: " << it << '\n'; + } + @endcode + + Range-based for loop with `items()` function: + + @code{cpp} + for (auto it : j_object.items()) + { + std::cout << "key: " << it.key() << ", value:" << it.value() << '\n'; + } + @endcode + + @note When iterating over an array, `key()` will return the index of the + element as string (see example). For primitive types (e.g., numbers), + `key()` returns an empty string. + + @return iteration proxy object wrapping @a ref with an interface to use in + range-based for loops + + @liveexample{The following code shows how the function is used.,items} + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 3.1.0. + */ + iteration_proxy<iterator> items() noexcept + { + return iteration_proxy<iterator>(*this); + } + + /*! + @copydoc items() + */ + iteration_proxy<const_iterator> items() const noexcept + { + return iteration_proxy<const_iterator>(*this); + } + + /// @} + + + ////////////// + // capacity // + ////////////// + + /// @name capacity + /// @{ + + /*! + @brief checks whether the container is empty. + + Checks if a JSON value has no elements (i.e. whether its @ref size is `0`). + + @return The return value depends on the different types and is + defined as follows: + Value type | return value + ----------- | ------------- + null | `true` + boolean | `false` + string | `false` + number | `false` + object | result of function `object_t::empty()` + array | result of function `array_t::empty()` + + @liveexample{The following code uses `empty()` to check if a JSON + object contains any elements.,empty} + + @complexity Constant, as long as @ref array_t and @ref object_t satisfy + the Container concept; that is, their `empty()` functions have constant + complexity. + + @iterators No changes. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @note This function does not return whether a string stored as JSON value + is empty - it returns whether the JSON container itself is empty which is + false in the case of a string. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of `begin() == end()`. + + @sa @ref size() -- returns the number of elements + + @since version 1.0.0 + */ + bool empty() const noexcept + { + switch (m_type) + { + case value_t::null: + { + // null values are empty + return true; + } + + case value_t::array: + { + // delegate call to array_t::empty() + return m_value.array->empty(); + } + + case value_t::object: + { + // delegate call to object_t::empty() + return m_value.object->empty(); + } + + default: + { + // all other types are nonempty + return false; + } + } + } + + /*! + @brief returns the number of elements + + Returns the number of elements in a JSON value. + + @return The return value depends on the different types and is + defined as follows: + Value type | return value + ----------- | ------------- + null | `0` + boolean | `1` + string | `1` + number | `1` + object | result of function object_t::size() + array | result of function array_t::size() + + @liveexample{The following code calls `size()` on the different value + types.,size} + + @complexity Constant, as long as @ref array_t and @ref object_t satisfy + the Container concept; that is, their size() functions have constant + complexity. + + @iterators No changes. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @note This function does not return the length of a string stored as JSON + value - it returns the number of elements in the JSON value which is 1 in + the case of a string. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of `std::distance(begin(), end())`. + + @sa @ref empty() -- checks whether the container is empty + @sa @ref max_size() -- returns the maximal number of elements + + @since version 1.0.0 + */ + size_type size() const noexcept + { + switch (m_type) + { + case value_t::null: + { + // null values are empty + return 0; + } + + case value_t::array: + { + // delegate call to array_t::size() + return m_value.array->size(); + } + + case value_t::object: + { + // delegate call to object_t::size() + return m_value.object->size(); + } + + default: + { + // all other types have size 1 + return 1; + } + } + } + + /*! + @brief returns the maximum possible number of elements + + Returns the maximum number of elements a JSON value is able to hold due to + system or library implementation limitations, i.e. `std::distance(begin(), + end())` for the JSON value. + + @return The return value depends on the different types and is + defined as follows: + Value type | return value + ----------- | ------------- + null | `0` (same as `size()`) + boolean | `1` (same as `size()`) + string | `1` (same as `size()`) + number | `1` (same as `size()`) + object | result of function `object_t::max_size()` + array | result of function `array_t::max_size()` + + @liveexample{The following code calls `max_size()` on the different value + types. Note the output is implementation specific.,max_size} + + @complexity Constant, as long as @ref array_t and @ref object_t satisfy + the Container concept; that is, their `max_size()` functions have constant + complexity. + + @iterators No changes. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @requirement This function helps `basic_json` satisfying the + [Container](https://en.cppreference.com/w/cpp/named_req/Container) + requirements: + - The complexity is constant. + - Has the semantics of returning `b.size()` where `b` is the largest + possible JSON value. + + @sa @ref size() -- returns the number of elements + + @since version 1.0.0 + */ + size_type max_size() const noexcept + { + switch (m_type) + { + case value_t::array: + { + // delegate call to array_t::max_size() + return m_value.array->max_size(); + } + + case value_t::object: + { + // delegate call to object_t::max_size() + return m_value.object->max_size(); + } + + default: + { + // all other types have max_size() == size() + return size(); + } + } + } + + /// @} + + + /////////////// + // modifiers // + /////////////// + + /// @name modifiers + /// @{ + + /*! + @brief clears the contents + + Clears the content of a JSON value and resets it to the default value as + if @ref basic_json(value_t) would have been called with the current value + type from @ref type(): + + Value type | initial value + ----------- | ------------- + null | `null` + boolean | `false` + string | `""` + number | `0` + object | `{}` + array | `[]` + + @post Has the same effect as calling + @code {.cpp} + *this = basic_json(type()); + @endcode + + @liveexample{The example below shows the effect of `clear()` to different + JSON types.,clear} + + @complexity Linear in the size of the JSON value. + + @iterators All iterators, pointers and references related to this container + are invalidated. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @sa @ref basic_json(value_t) -- constructor that creates an object with the + same value than calling `clear()` + + @since version 1.0.0 + */ + void clear() noexcept + { + switch (m_type) + { + case value_t::number_integer: + { + m_value.number_integer = 0; + break; + } + + case value_t::number_unsigned: + { + m_value.number_unsigned = 0; + break; + } + + case value_t::number_float: + { + m_value.number_float = 0.0; + break; + } + + case value_t::boolean: + { + m_value.boolean = false; + break; + } + + case value_t::string: + { + m_value.string->clear(); + break; + } + + case value_t::array: + { + m_value.array->clear(); + break; + } + + case value_t::object: + { + m_value.object->clear(); + break; + } + + default: + break; + } + } + + /*! + @brief add an object to an array + + Appends the given element @a val to the end of the JSON value. If the + function is called on a JSON null value, an empty array is created before + appending @a val. + + @param[in] val the value to add to the JSON array + + @throw type_error.308 when called on a type other than JSON array or + null; example: `"cannot use push_back() with number"` + + @complexity Amortized constant. + + @liveexample{The example shows how `push_back()` and `+=` can be used to + add elements to a JSON array. Note how the `null` value was silently + converted to a JSON array.,push_back} + + @since version 1.0.0 + */ + void push_back(basic_json&& val) + { + // push_back only works for null objects or arrays + if (JSON_UNLIKELY(not(is_null() or is_array()))) + { + JSON_THROW(type_error::create(308, "cannot use push_back() with " + std::string(type_name()))); + } + + // transform null object into an array + if (is_null()) + { + m_type = value_t::array; + m_value = value_t::array; + assert_invariant(); + } + + // add element to array (move semantics) + m_value.array->push_back(std::move(val)); + // invalidate object + val.m_type = value_t::null; + } + + /*! + @brief add an object to an array + @copydoc push_back(basic_json&&) + */ + reference operator+=(basic_json&& val) + { + push_back(std::move(val)); + return *this; + } + + /*! + @brief add an object to an array + @copydoc push_back(basic_json&&) + */ + void push_back(const basic_json& val) + { + // push_back only works for null objects or arrays + if (JSON_UNLIKELY(not(is_null() or is_array()))) + { + JSON_THROW(type_error::create(308, "cannot use push_back() with " + std::string(type_name()))); + } + + // transform null object into an array + if (is_null()) + { + m_type = value_t::array; + m_value = value_t::array; + assert_invariant(); + } + + // add element to array + m_value.array->push_back(val); + } + + /*! + @brief add an object to an array + @copydoc push_back(basic_json&&) + */ + reference operator+=(const basic_json& val) + { + push_back(val); + return *this; + } + + /*! + @brief add an object to an object + + Inserts the given element @a val to the JSON object. If the function is + called on a JSON null value, an empty object is created before inserting + @a val. + + @param[in] val the value to add to the JSON object + + @throw type_error.308 when called on a type other than JSON object or + null; example: `"cannot use push_back() with number"` + + @complexity Logarithmic in the size of the container, O(log(`size()`)). + + @liveexample{The example shows how `push_back()` and `+=` can be used to + add elements to a JSON object. Note how the `null` value was silently + converted to a JSON object.,push_back__object_t__value} + + @since version 1.0.0 + */ + void push_back(const typename object_t::value_type& val) + { + // push_back only works for null objects or objects + if (JSON_UNLIKELY(not(is_null() or is_object()))) + { + JSON_THROW(type_error::create(308, "cannot use push_back() with " + std::string(type_name()))); + } + + // transform null object into an object + if (is_null()) + { + m_type = value_t::object; + m_value = value_t::object; + assert_invariant(); + } + + // add element to array + m_value.object->insert(val); + } + + /*! + @brief add an object to an object + @copydoc push_back(const typename object_t::value_type&) + */ + reference operator+=(const typename object_t::value_type& val) + { + push_back(val); + return *this; + } + + /*! + @brief add an object to an object + + This function allows to use `push_back` with an initializer list. In case + + 1. the current value is an object, + 2. the initializer list @a init contains only two elements, and + 3. the first element of @a init is a string, + + @a init is converted into an object element and added using + @ref push_back(const typename object_t::value_type&). Otherwise, @a init + is converted to a JSON value and added using @ref push_back(basic_json&&). + + @param[in] init an initializer list + + @complexity Linear in the size of the initializer list @a init. + + @note This function is required to resolve an ambiguous overload error, + because pairs like `{"key", "value"}` can be both interpreted as + `object_t::value_type` or `std::initializer_list<basic_json>`, see + https://github.com/nlohmann/json/issues/235 for more information. + + @liveexample{The example shows how initializer lists are treated as + objects when possible.,push_back__initializer_list} + */ + void push_back(initializer_list_t init) + { + if (is_object() and init.size() == 2 and (*init.begin())->is_string()) + { + basic_json&& key = init.begin()->moved_or_copied(); + push_back(typename object_t::value_type( + std::move(key.get_ref<string_t&>()), (init.begin() + 1)->moved_or_copied())); + } + else + { + push_back(basic_json(init)); + } + } + + /*! + @brief add an object to an object + @copydoc push_back(initializer_list_t) + */ + reference operator+=(initializer_list_t init) + { + push_back(init); + return *this; + } + + /*! + @brief add an object to an array + + Creates a JSON value from the passed parameters @a args to the end of the + JSON value. If the function is called on a JSON null value, an empty array + is created before appending the value created from @a args. + + @param[in] args arguments to forward to a constructor of @ref basic_json + @tparam Args compatible types to create a @ref basic_json object + + @throw type_error.311 when called on a type other than JSON array or + null; example: `"cannot use emplace_back() with number"` + + @complexity Amortized constant. + + @liveexample{The example shows how `push_back()` can be used to add + elements to a JSON array. Note how the `null` value was silently converted + to a JSON array.,emplace_back} + + @since version 2.0.8 + */ + template<class... Args> + void emplace_back(Args&& ... args) + { + // emplace_back only works for null objects or arrays + if (JSON_UNLIKELY(not(is_null() or is_array()))) + { + JSON_THROW(type_error::create(311, "cannot use emplace_back() with " + std::string(type_name()))); + } + + // transform null object into an array + if (is_null()) + { + m_type = value_t::array; + m_value = value_t::array; + assert_invariant(); + } + + // add element to array (perfect forwarding) + m_value.array->emplace_back(std::forward<Args>(args)...); + } + + /*! + @brief add an object to an object if key does not exist + + Inserts a new element into a JSON object constructed in-place with the + given @a args if there is no element with the key in the container. If the + function is called on a JSON null value, an empty object is created before + appending the value created from @a args. + + @param[in] args arguments to forward to a constructor of @ref basic_json + @tparam Args compatible types to create a @ref basic_json object + + @return a pair consisting of an iterator to the inserted element, or the + already-existing element if no insertion happened, and a bool + denoting whether the insertion took place. + + @throw type_error.311 when called on a type other than JSON object or + null; example: `"cannot use emplace() with number"` + + @complexity Logarithmic in the size of the container, O(log(`size()`)). + + @liveexample{The example shows how `emplace()` can be used to add elements + to a JSON object. Note how the `null` value was silently converted to a + JSON object. Further note how no value is added if there was already one + value stored with the same key.,emplace} + + @since version 2.0.8 + */ + template<class... Args> + std::pair<iterator, bool> emplace(Args&& ... args) + { + // emplace only works for null objects or arrays + if (JSON_UNLIKELY(not(is_null() or is_object()))) + { + JSON_THROW(type_error::create(311, "cannot use emplace() with " + std::string(type_name()))); + } + + // transform null object into an object + if (is_null()) + { + m_type = value_t::object; + m_value = value_t::object; + assert_invariant(); + } + + // add element to array (perfect forwarding) + auto res = m_value.object->emplace(std::forward<Args>(args)...); + // create result iterator and set iterator to the result of emplace + auto it = begin(); + it.m_it.object_iterator = res.first; + + // return pair of iterator and boolean + return {it, res.second}; + } + + /*! + @brief inserts element + + Inserts element @a val before iterator @a pos. + + @param[in] pos iterator before which the content will be inserted; may be + the end() iterator + @param[in] val element to insert + @return iterator pointing to the inserted @a val. + + @throw type_error.309 if called on JSON values other than arrays; + example: `"cannot use insert() with string"` + @throw invalid_iterator.202 if @a pos is not an iterator of *this; + example: `"iterator does not fit current value"` + + @complexity Constant plus linear in the distance between @a pos and end of + the container. + + @liveexample{The example shows how `insert()` is used.,insert} + + @since version 1.0.0 + */ + iterator insert(const_iterator pos, const basic_json& val) + { + // insert only works for arrays + if (JSON_LIKELY(is_array())) + { + // check if iterator pos fits to this JSON value + if (JSON_UNLIKELY(pos.m_object != this)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + // insert to array and return iterator + iterator result(this); + result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val); + return result; + } + + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + /*! + @brief inserts element + @copydoc insert(const_iterator, const basic_json&) + */ + iterator insert(const_iterator pos, basic_json&& val) + { + return insert(pos, val); + } + + /*! + @brief inserts elements + + Inserts @a cnt copies of @a val before iterator @a pos. + + @param[in] pos iterator before which the content will be inserted; may be + the end() iterator + @param[in] cnt number of copies of @a val to insert + @param[in] val element to insert + @return iterator pointing to the first element inserted, or @a pos if + `cnt==0` + + @throw type_error.309 if called on JSON values other than arrays; example: + `"cannot use insert() with string"` + @throw invalid_iterator.202 if @a pos is not an iterator of *this; + example: `"iterator does not fit current value"` + + @complexity Linear in @a cnt plus linear in the distance between @a pos + and end of the container. + + @liveexample{The example shows how `insert()` is used.,insert__count} + + @since version 1.0.0 + */ + iterator insert(const_iterator pos, size_type cnt, const basic_json& val) + { + // insert only works for arrays + if (JSON_LIKELY(is_array())) + { + // check if iterator pos fits to this JSON value + if (JSON_UNLIKELY(pos.m_object != this)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + // insert to array and return iterator + iterator result(this); + result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val); + return result; + } + + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + /*! + @brief inserts elements + + Inserts elements from range `[first, last)` before iterator @a pos. + + @param[in] pos iterator before which the content will be inserted; may be + the end() iterator + @param[in] first begin of the range of elements to insert + @param[in] last end of the range of elements to insert + + @throw type_error.309 if called on JSON values other than arrays; example: + `"cannot use insert() with string"` + @throw invalid_iterator.202 if @a pos is not an iterator of *this; + example: `"iterator does not fit current value"` + @throw invalid_iterator.210 if @a first and @a last do not belong to the + same JSON value; example: `"iterators do not fit"` + @throw invalid_iterator.211 if @a first or @a last are iterators into + container for which insert is called; example: `"passed iterators may not + belong to container"` + + @return iterator pointing to the first element inserted, or @a pos if + `first==last` + + @complexity Linear in `std::distance(first, last)` plus linear in the + distance between @a pos and end of the container. + + @liveexample{The example shows how `insert()` is used.,insert__range} + + @since version 1.0.0 + */ + iterator insert(const_iterator pos, const_iterator first, const_iterator last) + { + // insert only works for arrays + if (JSON_UNLIKELY(not is_array())) + { + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + // check if iterator pos fits to this JSON value + if (JSON_UNLIKELY(pos.m_object != this)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + // check if range iterators belong to the same JSON object + if (JSON_UNLIKELY(first.m_object != last.m_object)) + { + JSON_THROW(invalid_iterator::create(210, "iterators do not fit")); + } + + if (JSON_UNLIKELY(first.m_object == this)) + { + JSON_THROW(invalid_iterator::create(211, "passed iterators may not belong to container")); + } + + // insert to array and return iterator + iterator result(this); + result.m_it.array_iterator = m_value.array->insert( + pos.m_it.array_iterator, + first.m_it.array_iterator, + last.m_it.array_iterator); + return result; + } + + /*! + @brief inserts elements + + Inserts elements from initializer list @a ilist before iterator @a pos. + + @param[in] pos iterator before which the content will be inserted; may be + the end() iterator + @param[in] ilist initializer list to insert the values from + + @throw type_error.309 if called on JSON values other than arrays; example: + `"cannot use insert() with string"` + @throw invalid_iterator.202 if @a pos is not an iterator of *this; + example: `"iterator does not fit current value"` + + @return iterator pointing to the first element inserted, or @a pos if + `ilist` is empty + + @complexity Linear in `ilist.size()` plus linear in the distance between + @a pos and end of the container. + + @liveexample{The example shows how `insert()` is used.,insert__ilist} + + @since version 1.0.0 + */ + iterator insert(const_iterator pos, initializer_list_t ilist) + { + // insert only works for arrays + if (JSON_UNLIKELY(not is_array())) + { + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + // check if iterator pos fits to this JSON value + if (JSON_UNLIKELY(pos.m_object != this)) + { + JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); + } + + // insert to array and return iterator + iterator result(this); + result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, ilist.begin(), ilist.end()); + return result; + } + + /*! + @brief inserts elements + + Inserts elements from range `[first, last)`. + + @param[in] first begin of the range of elements to insert + @param[in] last end of the range of elements to insert + + @throw type_error.309 if called on JSON values other than objects; example: + `"cannot use insert() with string"` + @throw invalid_iterator.202 if iterator @a first or @a last does does not + point to an object; example: `"iterators first and last must point to + objects"` + @throw invalid_iterator.210 if @a first and @a last do not belong to the + same JSON value; example: `"iterators do not fit"` + + @complexity Logarithmic: `O(N*log(size() + N))`, where `N` is the number + of elements to insert. + + @liveexample{The example shows how `insert()` is used.,insert__range_object} + + @since version 3.0.0 + */ + void insert(const_iterator first, const_iterator last) + { + // insert only works for objects + if (JSON_UNLIKELY(not is_object())) + { + JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()))); + } + + // check if range iterators belong to the same JSON object + if (JSON_UNLIKELY(first.m_object != last.m_object)) + { + JSON_THROW(invalid_iterator::create(210, "iterators do not fit")); + } + + // passed iterators must belong to objects + if (JSON_UNLIKELY(not first.m_object->is_object())) + { + JSON_THROW(invalid_iterator::create(202, "iterators first and last must point to objects")); + } + + m_value.object->insert(first.m_it.object_iterator, last.m_it.object_iterator); + } + + /*! + @brief updates a JSON object from another object, overwriting existing keys + + Inserts all values from JSON object @a j and overwrites existing keys. + + @param[in] j JSON object to read values from + + @throw type_error.312 if called on JSON values other than objects; example: + `"cannot use update() with string"` + + @complexity O(N*log(size() + N)), where N is the number of elements to + insert. + + @liveexample{The example shows how `update()` is used.,update} + + @sa https://docs.python.org/3.6/library/stdtypes.html#dict.update + + @since version 3.0.0 + */ + void update(const_reference j) + { + // implicitly convert null value to an empty object + if (is_null()) + { + m_type = value_t::object; + m_value.object = create<object_t>(); + assert_invariant(); + } + + if (JSON_UNLIKELY(not is_object())) + { + JSON_THROW(type_error::create(312, "cannot use update() with " + std::string(type_name()))); + } + if (JSON_UNLIKELY(not j.is_object())) + { + JSON_THROW(type_error::create(312, "cannot use update() with " + std::string(j.type_name()))); + } + + for (auto it = j.cbegin(); it != j.cend(); ++it) + { + m_value.object->operator[](it.key()) = it.value(); + } + } + + /*! + @brief updates a JSON object from another object, overwriting existing keys + + Inserts all values from from range `[first, last)` and overwrites existing + keys. + + @param[in] first begin of the range of elements to insert + @param[in] last end of the range of elements to insert + + @throw type_error.312 if called on JSON values other than objects; example: + `"cannot use update() with string"` + @throw invalid_iterator.202 if iterator @a first or @a last does does not + point to an object; example: `"iterators first and last must point to + objects"` + @throw invalid_iterator.210 if @a first and @a last do not belong to the + same JSON value; example: `"iterators do not fit"` + + @complexity O(N*log(size() + N)), where N is the number of elements to + insert. + + @liveexample{The example shows how `update()` is used__range.,update} + + @sa https://docs.python.org/3.6/library/stdtypes.html#dict.update + + @since version 3.0.0 + */ + void update(const_iterator first, const_iterator last) + { + // implicitly convert null value to an empty object + if (is_null()) + { + m_type = value_t::object; + m_value.object = create<object_t>(); + assert_invariant(); + } + + if (JSON_UNLIKELY(not is_object())) + { + JSON_THROW(type_error::create(312, "cannot use update() with " + std::string(type_name()))); + } + + // check if range iterators belong to the same JSON object + if (JSON_UNLIKELY(first.m_object != last.m_object)) + { + JSON_THROW(invalid_iterator::create(210, "iterators do not fit")); + } + + // passed iterators must belong to objects + if (JSON_UNLIKELY(not first.m_object->is_object() + or not last.m_object->is_object())) + { + JSON_THROW(invalid_iterator::create(202, "iterators first and last must point to objects")); + } + + for (auto it = first; it != last; ++it) + { + m_value.object->operator[](it.key()) = it.value(); + } + } + + /*! + @brief exchanges the values + + Exchanges the contents of the JSON value with those of @a other. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. + + @param[in,out] other JSON value to exchange the contents with + + @complexity Constant. + + @liveexample{The example below shows how JSON values can be swapped with + `swap()`.,swap__reference} + + @since version 1.0.0 + */ + void swap(reference other) noexcept ( + std::is_nothrow_move_constructible<value_t>::value and + std::is_nothrow_move_assignable<value_t>::value and + std::is_nothrow_move_constructible<json_value>::value and + std::is_nothrow_move_assignable<json_value>::value + ) + { + std::swap(m_type, other.m_type); + std::swap(m_value, other.m_value); + assert_invariant(); + } + + /*! + @brief exchanges the values + + Exchanges the contents of a JSON array with those of @a other. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. + + @param[in,out] other array to exchange the contents with + + @throw type_error.310 when JSON value is not an array; example: `"cannot + use swap() with string"` + + @complexity Constant. + + @liveexample{The example below shows how arrays can be swapped with + `swap()`.,swap__array_t} + + @since version 1.0.0 + */ + void swap(array_t& other) + { + // swap only works for arrays + if (JSON_LIKELY(is_array())) + { + std::swap(*(m_value.array), other); + } + else + { + JSON_THROW(type_error::create(310, "cannot use swap() with " + std::string(type_name()))); + } + } + + /*! + @brief exchanges the values + + Exchanges the contents of a JSON object with those of @a other. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. + + @param[in,out] other object to exchange the contents with + + @throw type_error.310 when JSON value is not an object; example: + `"cannot use swap() with string"` + + @complexity Constant. + + @liveexample{The example below shows how objects can be swapped with + `swap()`.,swap__object_t} + + @since version 1.0.0 + */ + void swap(object_t& other) + { + // swap only works for objects + if (JSON_LIKELY(is_object())) + { + std::swap(*(m_value.object), other); + } + else + { + JSON_THROW(type_error::create(310, "cannot use swap() with " + std::string(type_name()))); + } + } + + /*! + @brief exchanges the values + + Exchanges the contents of a JSON string with those of @a other. Does not + invoke any move, copy, or swap operations on individual elements. All + iterators and references remain valid. The past-the-end iterator is + invalidated. + + @param[in,out] other string to exchange the contents with + + @throw type_error.310 when JSON value is not a string; example: `"cannot + use swap() with boolean"` + + @complexity Constant. + + @liveexample{The example below shows how strings can be swapped with + `swap()`.,swap__string_t} + + @since version 1.0.0 + */ + void swap(string_t& other) + { + // swap only works for strings + if (JSON_LIKELY(is_string())) + { + std::swap(*(m_value.string), other); + } + else + { + JSON_THROW(type_error::create(310, "cannot use swap() with " + std::string(type_name()))); + } + } + + /// @} + + public: + ////////////////////////////////////////// + // lexicographical comparison operators // + ////////////////////////////////////////// + + /// @name lexicographical comparison operators + /// @{ + + /*! + @brief comparison: equal + + Compares two JSON values for equality according to the following rules: + - Two JSON values are equal if (1) they are from the same type and (2) + their stored values are the same according to their respective + `operator==`. + - Integer and floating-point numbers are automatically converted before + comparison. Note than two NaN values are always treated as unequal. + - Two JSON null values are equal. + + @note Floating-point inside JSON values numbers are compared with + `json::number_float_t::operator==` which is `double::operator==` by + default. To compare floating-point while respecting an epsilon, an alternative + [comparison function](https://github.com/mariokonrad/marnav/blob/master/src/marnav/math/floatingpoint.hpp#L34-#L39) + could be used, for instance + @code {.cpp} + template<typename T, typename = typename std::enable_if<std::is_floating_point<T>::value, T>::type> + inline bool is_same(T a, T b, T epsilon = std::numeric_limits<T>::epsilon()) noexcept + { + return std::abs(a - b) <= epsilon; + } + @endcode + + @note NaN values never compare equal to themselves or to other NaN values. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether the values @a lhs and @a rhs are equal + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @complexity Linear. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__equal} + + @since version 1.0.0 + */ + friend bool operator==(const_reference lhs, const_reference rhs) noexcept + { + const auto lhs_type = lhs.type(); + const auto rhs_type = rhs.type(); + + if (lhs_type == rhs_type) + { + switch (lhs_type) + { + case value_t::array: + return (*lhs.m_value.array == *rhs.m_value.array); + + case value_t::object: + return (*lhs.m_value.object == *rhs.m_value.object); + + case value_t::null: + return true; + + case value_t::string: + return (*lhs.m_value.string == *rhs.m_value.string); + + case value_t::boolean: + return (lhs.m_value.boolean == rhs.m_value.boolean); + + case value_t::number_integer: + return (lhs.m_value.number_integer == rhs.m_value.number_integer); + + case value_t::number_unsigned: + return (lhs.m_value.number_unsigned == rhs.m_value.number_unsigned); + + case value_t::number_float: + return (lhs.m_value.number_float == rhs.m_value.number_float); + + default: + return false; + } + } + else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float) + { + return (static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float); + } + else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer) + { + return (lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer)); + } + else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float) + { + return (static_cast<number_float_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_float); + } + else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned) + { + return (lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_unsigned)); + } + else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer) + { + return (static_cast<number_integer_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_integer); + } + else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned) + { + return (lhs.m_value.number_integer == static_cast<number_integer_t>(rhs.m_value.number_unsigned)); + } + + return false; + } + + /*! + @brief comparison: equal + @copydoc operator==(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept + { + return (lhs == basic_json(rhs)); + } + + /*! + @brief comparison: equal + @copydoc operator==(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept + { + return (basic_json(lhs) == rhs); + } + + /*! + @brief comparison: not equal + + Compares two JSON values for inequality by calculating `not (lhs == rhs)`. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether the values @a lhs and @a rhs are not equal + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__notequal} + + @since version 1.0.0 + */ + friend bool operator!=(const_reference lhs, const_reference rhs) noexcept + { + return not (lhs == rhs); + } + + /*! + @brief comparison: not equal + @copydoc operator!=(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator!=(const_reference lhs, const ScalarType rhs) noexcept + { + return (lhs != basic_json(rhs)); + } + + /*! + @brief comparison: not equal + @copydoc operator!=(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator!=(const ScalarType lhs, const_reference rhs) noexcept + { + return (basic_json(lhs) != rhs); + } + + /*! + @brief comparison: less than + + Compares whether one JSON value @a lhs is less than another JSON value @a + rhs according to the following rules: + - If @a lhs and @a rhs have the same type, the values are compared using + the default `<` operator. + - Integer and floating-point numbers are automatically converted before + comparison + - In case @a lhs and @a rhs have different types, the values are ignored + and the order of the types is considered, see + @ref operator<(const value_t, const value_t). + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether @a lhs is less than @a rhs + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__less} + + @since version 1.0.0 + */ + friend bool operator<(const_reference lhs, const_reference rhs) noexcept + { + const auto lhs_type = lhs.type(); + const auto rhs_type = rhs.type(); + + if (lhs_type == rhs_type) + { + switch (lhs_type) + { + case value_t::array: + return (*lhs.m_value.array) < (*rhs.m_value.array); + + case value_t::object: + return *lhs.m_value.object < *rhs.m_value.object; + + case value_t::null: + return false; + + case value_t::string: + return *lhs.m_value.string < *rhs.m_value.string; + + case value_t::boolean: + return lhs.m_value.boolean < rhs.m_value.boolean; + + case value_t::number_integer: + return lhs.m_value.number_integer < rhs.m_value.number_integer; + + case value_t::number_unsigned: + return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned; + + case value_t::number_float: + return lhs.m_value.number_float < rhs.m_value.number_float; + + default: + return false; + } + } + else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float) + { + return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float; + } + else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer) + { + return lhs.m_value.number_float < static_cast<number_float_t>(rhs.m_value.number_integer); + } + else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float) + { + return static_cast<number_float_t>(lhs.m_value.number_unsigned) < rhs.m_value.number_float; + } + else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned) + { + return lhs.m_value.number_float < static_cast<number_float_t>(rhs.m_value.number_unsigned); + } + else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned) + { + return lhs.m_value.number_integer < static_cast<number_integer_t>(rhs.m_value.number_unsigned); + } + else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer) + { + return static_cast<number_integer_t>(lhs.m_value.number_unsigned) < rhs.m_value.number_integer; + } + + // We only reach this line if we cannot compare values. In that case, + // we compare types. Note we have to call the operator explicitly, + // because MSVC has problems otherwise. + return operator<(lhs_type, rhs_type); + } + + /*! + @brief comparison: less than + @copydoc operator<(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator<(const_reference lhs, const ScalarType rhs) noexcept + { + return (lhs < basic_json(rhs)); + } + + /*! + @brief comparison: less than + @copydoc operator<(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator<(const ScalarType lhs, const_reference rhs) noexcept + { + return (basic_json(lhs) < rhs); + } + + /*! + @brief comparison: less than or equal + + Compares whether one JSON value @a lhs is less than or equal to another + JSON value by calculating `not (rhs < lhs)`. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether @a lhs is less than or equal to @a rhs + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__greater} + + @since version 1.0.0 + */ + friend bool operator<=(const_reference lhs, const_reference rhs) noexcept + { + return not (rhs < lhs); + } + + /*! + @brief comparison: less than or equal + @copydoc operator<=(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator<=(const_reference lhs, const ScalarType rhs) noexcept + { + return (lhs <= basic_json(rhs)); + } + + /*! + @brief comparison: less than or equal + @copydoc operator<=(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator<=(const ScalarType lhs, const_reference rhs) noexcept + { + return (basic_json(lhs) <= rhs); + } + + /*! + @brief comparison: greater than + + Compares whether one JSON value @a lhs is greater than another + JSON value by calculating `not (lhs <= rhs)`. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether @a lhs is greater than to @a rhs + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__lessequal} + + @since version 1.0.0 + */ + friend bool operator>(const_reference lhs, const_reference rhs) noexcept + { + return not (lhs <= rhs); + } + + /*! + @brief comparison: greater than + @copydoc operator>(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator>(const_reference lhs, const ScalarType rhs) noexcept + { + return (lhs > basic_json(rhs)); + } + + /*! + @brief comparison: greater than + @copydoc operator>(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator>(const ScalarType lhs, const_reference rhs) noexcept + { + return (basic_json(lhs) > rhs); + } + + /*! + @brief comparison: greater than or equal + + Compares whether one JSON value @a lhs is greater than or equal to another + JSON value by calculating `not (lhs < rhs)`. + + @param[in] lhs first JSON value to consider + @param[in] rhs second JSON value to consider + @return whether @a lhs is greater than or equal to @a rhs + + @complexity Linear. + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @liveexample{The example demonstrates comparing several JSON + types.,operator__greaterequal} + + @since version 1.0.0 + */ + friend bool operator>=(const_reference lhs, const_reference rhs) noexcept + { + return not (lhs < rhs); + } + + /*! + @brief comparison: greater than or equal + @copydoc operator>=(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator>=(const_reference lhs, const ScalarType rhs) noexcept + { + return (lhs >= basic_json(rhs)); + } + + /*! + @brief comparison: greater than or equal + @copydoc operator>=(const_reference, const_reference) + */ + template<typename ScalarType, typename std::enable_if< + std::is_scalar<ScalarType>::value, int>::type = 0> + friend bool operator>=(const ScalarType lhs, const_reference rhs) noexcept + { + return (basic_json(lhs) >= rhs); + } + + /// @} + + /////////////////// + // serialization // + /////////////////// + + /// @name serialization + /// @{ + + /*! + @brief serialize to stream + + Serialize the given JSON value @a j to the output stream @a o. The JSON + value will be serialized using the @ref dump member function. + + - The indentation of the output can be controlled with the member variable + `width` of the output stream @a o. For instance, using the manipulator + `std::setw(4)` on @a o sets the indentation level to `4` and the + serialization result is the same as calling `dump(4)`. + + - The indentation character can be controlled with the member variable + `fill` of the output stream @a o. For instance, the manipulator + `std::setfill('\\t')` sets indentation to use a tab character rather than + the default space character. + + @param[in,out] o stream to serialize to + @param[in] j JSON value to serialize + + @return the stream @a o + + @throw type_error.316 if a string stored inside the JSON value is not + UTF-8 encoded + + @complexity Linear. + + @liveexample{The example below shows the serialization with different + parameters to `width` to adjust the indentation level.,operator_serialize} + + @since version 1.0.0; indentation character added in version 3.0.0 + */ + friend std::ostream& operator<<(std::ostream& o, const basic_json& j) + { + // read width member and use it as indentation parameter if nonzero + const bool pretty_print = (o.width() > 0); + const auto indentation = (pretty_print ? o.width() : 0); + + // reset width to 0 for subsequent calls to this stream + o.width(0); + + // do the actual serialization + serializer s(detail::output_adapter<char>(o), o.fill()); + s.dump(j, pretty_print, false, static_cast<unsigned int>(indentation)); + return o; + } + + /*! + @brief serialize to stream + @deprecated This stream operator is deprecated and will be removed in + future 4.0.0 of the library. Please use + @ref operator<<(std::ostream&, const basic_json&) + instead; that is, replace calls like `j >> o;` with `o << j;`. + @since version 1.0.0; deprecated since version 3.0.0 + */ + JSON_DEPRECATED + friend std::ostream& operator>>(const basic_json& j, std::ostream& o) + { + return o << j; + } + + /// @} + + + ///////////////////// + // deserialization // + ///////////////////// + + /// @name deserialization + /// @{ + + /*! + @brief deserialize from a compatible input + + This function reads from a compatible input. Examples are: + - an array of 1-byte values + - strings with character/literal type with size of 1 byte + - input streams + - container with contiguous storage of 1-byte values. Compatible container + types include `std::vector`, `std::string`, `std::array`, + `std::valarray`, and `std::initializer_list`. Furthermore, C-style + arrays can be used with `std::begin()`/`std::end()`. User-defined + containers can be used as long as they implement random-access iterators + and a contiguous storage. + + @pre Each element of the container has a size of 1 byte. Violating this + precondition yields undefined behavior. **This precondition is enforced + with a static assertion.** + + @pre The container storage is contiguous. Violating this precondition + yields undefined behavior. **This precondition is enforced with an + assertion.** + @pre Each element of the container has a size of 1 byte. Violating this + precondition yields undefined behavior. **This precondition is enforced + with a static assertion.** + + @warning There is no way to enforce all preconditions at compile-time. If + the function is called with a noncompliant container and with + assertions switched off, the behavior is undefined and will most + likely yield segmentation violation. + + @param[in] i input to read from + @param[in] cb a parser callback function of type @ref parser_callback_t + which is used to control the deserialization by filtering unwanted values + (optional) + + @return result of the deserialization + + @throw parse_error.101 if a parse error occurs; example: `""unexpected end + of input; expected string literal""` + @throw parse_error.102 if to_unicode fails or surrogate error + @throw parse_error.103 if to_unicode fails + + @complexity Linear in the length of the input. The parser is a predictive + LL(1) parser. The complexity can be higher if the parser callback function + @a cb has a super-linear complexity. + + @note A UTF-8 byte order mark is silently ignored. + + @liveexample{The example below demonstrates the `parse()` function reading + from an array.,parse__array__parser_callback_t} + + @liveexample{The example below demonstrates the `parse()` function with + and without callback function.,parse__string__parser_callback_t} + + @liveexample{The example below demonstrates the `parse()` function with + and without callback function.,parse__istream__parser_callback_t} + + @liveexample{The example below demonstrates the `parse()` function reading + from a contiguous container.,parse__contiguouscontainer__parser_callback_t} + + @since version 2.0.3 (contiguous containers) + */ + static basic_json parse(detail::input_adapter&& i, + const parser_callback_t cb = nullptr, + const bool allow_exceptions = true) + { + basic_json result; + parser(i, cb, allow_exceptions).parse(true, result); + return result; + } + + static bool accept(detail::input_adapter&& i) + { + return parser(i).accept(true); + } + + static bool sax_parse(detail::input_adapter&& i, json_sax_t* sax, + input_format_t format = input_format_t::json, + const bool strict = true) + { + assert(sax); + switch (format) + { + case input_format_t::json: + return parser(std::move(i)).sax_parse(sax, strict); + default: + return binary_reader(std::move(i)).sax_parse(format, sax, strict); + } + } + + /*! + @brief deserialize from an iterator range with contiguous storage + + This function reads from an iterator range of a container with contiguous + storage of 1-byte values. Compatible container types include + `std::vector`, `std::string`, `std::array`, `std::valarray`, and + `std::initializer_list`. Furthermore, C-style arrays can be used with + `std::begin()`/`std::end()`. User-defined containers can be used as long + as they implement random-access iterators and a contiguous storage. + + @pre The iterator range is contiguous. Violating this precondition yields + undefined behavior. **This precondition is enforced with an assertion.** + @pre Each element in the range has a size of 1 byte. Violating this + precondition yields undefined behavior. **This precondition is enforced + with a static assertion.** + + @warning There is no way to enforce all preconditions at compile-time. If + the function is called with noncompliant iterators and with + assertions switched off, the behavior is undefined and will most + likely yield segmentation violation. + + @tparam IteratorType iterator of container with contiguous storage + @param[in] first begin of the range to parse (included) + @param[in] last end of the range to parse (excluded) + @param[in] cb a parser callback function of type @ref parser_callback_t + which is used to control the deserialization by filtering unwanted values + (optional) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + + @return result of the deserialization + + @throw parse_error.101 in case of an unexpected token + @throw parse_error.102 if to_unicode fails or surrogate error + @throw parse_error.103 if to_unicode fails + + @complexity Linear in the length of the input. The parser is a predictive + LL(1) parser. The complexity can be higher if the parser callback function + @a cb has a super-linear complexity. + + @note A UTF-8 byte order mark is silently ignored. + + @liveexample{The example below demonstrates the `parse()` function reading + from an iterator range.,parse__iteratortype__parser_callback_t} + + @since version 2.0.3 + */ + template<class IteratorType, typename std::enable_if< + std::is_base_of< + std::random_access_iterator_tag, + typename std::iterator_traits<IteratorType>::iterator_category>::value, int>::type = 0> + static basic_json parse(IteratorType first, IteratorType last, + const parser_callback_t cb = nullptr, + const bool allow_exceptions = true) + { + basic_json result; + parser(detail::input_adapter(first, last), cb, allow_exceptions).parse(true, result); + return result; + } + + template<class IteratorType, typename std::enable_if< + std::is_base_of< + std::random_access_iterator_tag, + typename std::iterator_traits<IteratorType>::iterator_category>::value, int>::type = 0> + static bool accept(IteratorType first, IteratorType last) + { + return parser(detail::input_adapter(first, last)).accept(true); + } + + template<class IteratorType, typename std::enable_if< + std::is_base_of< + std::random_access_iterator_tag, + typename std::iterator_traits<IteratorType>::iterator_category>::value, int>::type = 0> + static bool sax_parse(IteratorType first, IteratorType last, json_sax_t* sax) + { + return parser(detail::input_adapter(first, last)).sax_parse(sax); + } + + /*! + @brief deserialize from stream + @deprecated This stream operator is deprecated and will be removed in + version 4.0.0 of the library. Please use + @ref operator>>(std::istream&, basic_json&) + instead; that is, replace calls like `j << i;` with `i >> j;`. + @since version 1.0.0; deprecated since version 3.0.0 + */ + JSON_DEPRECATED + friend std::istream& operator<<(basic_json& j, std::istream& i) + { + return operator>>(i, j); + } + + /*! + @brief deserialize from stream + + Deserializes an input stream to a JSON value. + + @param[in,out] i input stream to read a serialized JSON value from + @param[in,out] j JSON value to write the deserialized input to + + @throw parse_error.101 in case of an unexpected token + @throw parse_error.102 if to_unicode fails or surrogate error + @throw parse_error.103 if to_unicode fails + + @complexity Linear in the length of the input. The parser is a predictive + LL(1) parser. + + @note A UTF-8 byte order mark is silently ignored. + + @liveexample{The example below shows how a JSON value is constructed by + reading a serialization from a stream.,operator_deserialize} + + @sa parse(std::istream&, const parser_callback_t) for a variant with a + parser callback function to filter values while parsing + + @since version 1.0.0 + */ + friend std::istream& operator>>(std::istream& i, basic_json& j) + { + parser(detail::input_adapter(i)).parse(false, j); + return i; + } + + /// @} + + /////////////////////////// + // convenience functions // + /////////////////////////// + + /*! + @brief return the type as string + + Returns the type name as string to be used in error messages - usually to + indicate that a function was called on a wrong JSON type. + + @return a string representation of a the @a m_type member: + Value type | return value + ----------- | ------------- + null | `"null"` + boolean | `"boolean"` + string | `"string"` + number | `"number"` (for all number types) + object | `"object"` + array | `"array"` + discarded | `"discarded"` + + @exceptionsafety No-throw guarantee: this function never throws exceptions. + + @complexity Constant. + + @liveexample{The following code exemplifies `type_name()` for all JSON + types.,type_name} + + @sa @ref type() -- return the type of the JSON value + @sa @ref operator value_t() -- return the type of the JSON value (implicit) + + @since version 1.0.0, public since 2.1.0, `const char*` and `noexcept` + since 3.0.0 + */ + const char* type_name() const noexcept + { + { + switch (m_type) + { + case value_t::null: + return "null"; + case value_t::object: + return "object"; + case value_t::array: + return "array"; + case value_t::string: + return "string"; + case value_t::boolean: + return "boolean"; + case value_t::discarded: + return "discarded"; + default: + return "number"; + } + } + } + + + private: + ////////////////////// + // member variables // + ////////////////////// + + /// the type of the current element + value_t m_type = value_t::null; + + /// the value of the current element + json_value m_value = {}; + + ////////////////////////////////////////// + // binary serialization/deserialization // + ////////////////////////////////////////// + + /// @name binary serialization/deserialization support + /// @{ + + public: + /*! + @brief create a CBOR serialization of a given JSON value + + Serializes a given JSON value @a j to a byte vector using the CBOR (Concise + Binary Object Representation) serialization format. CBOR is a binary + serialization format which aims to be more compact than JSON itself, yet + more efficient to parse. + + The library uses the following mapping from JSON values types to + CBOR types according to the CBOR specification (RFC 7049): + + JSON value type | value/range | CBOR type | first byte + --------------- | ------------------------------------------ | ---------------------------------- | --------------- + null | `null` | Null | 0xF6 + boolean | `true` | True | 0xF5 + boolean | `false` | False | 0xF4 + number_integer | -9223372036854775808..-2147483649 | Negative integer (8 bytes follow) | 0x3B + number_integer | -2147483648..-32769 | Negative integer (4 bytes follow) | 0x3A + number_integer | -32768..-129 | Negative integer (2 bytes follow) | 0x39 + number_integer | -128..-25 | Negative integer (1 byte follow) | 0x38 + number_integer | -24..-1 | Negative integer | 0x20..0x37 + number_integer | 0..23 | Integer | 0x00..0x17 + number_integer | 24..255 | Unsigned integer (1 byte follow) | 0x18 + number_integer | 256..65535 | Unsigned integer (2 bytes follow) | 0x19 + number_integer | 65536..4294967295 | Unsigned integer (4 bytes follow) | 0x1A + number_integer | 4294967296..18446744073709551615 | Unsigned integer (8 bytes follow) | 0x1B + number_unsigned | 0..23 | Integer | 0x00..0x17 + number_unsigned | 24..255 | Unsigned integer (1 byte follow) | 0x18 + number_unsigned | 256..65535 | Unsigned integer (2 bytes follow) | 0x19 + number_unsigned | 65536..4294967295 | Unsigned integer (4 bytes follow) | 0x1A + number_unsigned | 4294967296..18446744073709551615 | Unsigned integer (8 bytes follow) | 0x1B + number_float | *any value* | Double-Precision Float | 0xFB + string | *length*: 0..23 | UTF-8 string | 0x60..0x77 + string | *length*: 23..255 | UTF-8 string (1 byte follow) | 0x78 + string | *length*: 256..65535 | UTF-8 string (2 bytes follow) | 0x79 + string | *length*: 65536..4294967295 | UTF-8 string (4 bytes follow) | 0x7A + string | *length*: 4294967296..18446744073709551615 | UTF-8 string (8 bytes follow) | 0x7B + array | *size*: 0..23 | array | 0x80..0x97 + array | *size*: 23..255 | array (1 byte follow) | 0x98 + array | *size*: 256..65535 | array (2 bytes follow) | 0x99 + array | *size*: 65536..4294967295 | array (4 bytes follow) | 0x9A + array | *size*: 4294967296..18446744073709551615 | array (8 bytes follow) | 0x9B + object | *size*: 0..23 | map | 0xA0..0xB7 + object | *size*: 23..255 | map (1 byte follow) | 0xB8 + object | *size*: 256..65535 | map (2 bytes follow) | 0xB9 + object | *size*: 65536..4294967295 | map (4 bytes follow) | 0xBA + object | *size*: 4294967296..18446744073709551615 | map (8 bytes follow) | 0xBB + + @note The mapping is **complete** in the sense that any JSON value type + can be converted to a CBOR value. + + @note If NaN or Infinity are stored inside a JSON number, they are + serialized properly. This behavior differs from the @ref dump() + function which serializes NaN or Infinity to `null`. + + @note The following CBOR types are not used in the conversion: + - byte strings (0x40..0x5F) + - UTF-8 strings terminated by "break" (0x7F) + - arrays terminated by "break" (0x9F) + - maps terminated by "break" (0xBF) + - date/time (0xC0..0xC1) + - bignum (0xC2..0xC3) + - decimal fraction (0xC4) + - bigfloat (0xC5) + - tagged items (0xC6..0xD4, 0xD8..0xDB) + - expected conversions (0xD5..0xD7) + - simple values (0xE0..0xF3, 0xF8) + - undefined (0xF7) + - half and single-precision floats (0xF9-0xFA) + - break (0xFF) + + @param[in] j JSON value to serialize + @return MessagePack serialization as byte vector + + @complexity Linear in the size of the JSON value @a j. + + @liveexample{The example shows the serialization of a JSON value to a byte + vector in CBOR format.,to_cbor} + + @sa http://cbor.io + @sa @ref from_cbor(detail::input_adapter, const bool strict) for the + analogous deserialization + @sa @ref to_msgpack(const basic_json&) for the related MessagePack format + @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the + related UBJSON format + + @since version 2.0.9 + */ + static std::vector<uint8_t> to_cbor(const basic_json& j) + { + std::vector<uint8_t> result; + to_cbor(j, result); + return result; + } + + static void to_cbor(const basic_json& j, detail::output_adapter<uint8_t> o) + { + binary_writer<uint8_t>(o).write_cbor(j); + } + + static void to_cbor(const basic_json& j, detail::output_adapter<char> o) + { + binary_writer<char>(o).write_cbor(j); + } + + /*! + @brief create a MessagePack serialization of a given JSON value + + Serializes a given JSON value @a j to a byte vector using the MessagePack + serialization format. MessagePack is a binary serialization format which + aims to be more compact than JSON itself, yet more efficient to parse. + + The library uses the following mapping from JSON values types to + MessagePack types according to the MessagePack specification: + + JSON value type | value/range | MessagePack type | first byte + --------------- | --------------------------------- | ---------------- | ---------- + null | `null` | nil | 0xC0 + boolean | `true` | true | 0xC3 + boolean | `false` | false | 0xC2 + number_integer | -9223372036854775808..-2147483649 | int64 | 0xD3 + number_integer | -2147483648..-32769 | int32 | 0xD2 + number_integer | -32768..-129 | int16 | 0xD1 + number_integer | -128..-33 | int8 | 0xD0 + number_integer | -32..-1 | negative fixint | 0xE0..0xFF + number_integer | 0..127 | positive fixint | 0x00..0x7F + number_integer | 128..255 | uint 8 | 0xCC + number_integer | 256..65535 | uint 16 | 0xCD + number_integer | 65536..4294967295 | uint 32 | 0xCE + number_integer | 4294967296..18446744073709551615 | uint 64 | 0xCF + number_unsigned | 0..127 | positive fixint | 0x00..0x7F + number_unsigned | 128..255 | uint 8 | 0xCC + number_unsigned | 256..65535 | uint 16 | 0xCD + number_unsigned | 65536..4294967295 | uint 32 | 0xCE + number_unsigned | 4294967296..18446744073709551615 | uint 64 | 0xCF + number_float | *any value* | float 64 | 0xCB + string | *length*: 0..31 | fixstr | 0xA0..0xBF + string | *length*: 32..255 | str 8 | 0xD9 + string | *length*: 256..65535 | str 16 | 0xDA + string | *length*: 65536..4294967295 | str 32 | 0xDB + array | *size*: 0..15 | fixarray | 0x90..0x9F + array | *size*: 16..65535 | array 16 | 0xDC + array | *size*: 65536..4294967295 | array 32 | 0xDD + object | *size*: 0..15 | fix map | 0x80..0x8F + object | *size*: 16..65535 | map 16 | 0xDE + object | *size*: 65536..4294967295 | map 32 | 0xDF + + @note The mapping is **complete** in the sense that any JSON value type + can be converted to a MessagePack value. + + @note The following values can **not** be converted to a MessagePack value: + - strings with more than 4294967295 bytes + - arrays with more than 4294967295 elements + - objects with more than 4294967295 elements + + @note The following MessagePack types are not used in the conversion: + - bin 8 - bin 32 (0xC4..0xC6) + - ext 8 - ext 32 (0xC7..0xC9) + - float 32 (0xCA) + - fixext 1 - fixext 16 (0xD4..0xD8) + + @note Any MessagePack output created @ref to_msgpack can be successfully + parsed by @ref from_msgpack. + + @note If NaN or Infinity are stored inside a JSON number, they are + serialized properly. This behavior differs from the @ref dump() + function which serializes NaN or Infinity to `null`. + + @param[in] j JSON value to serialize + @return MessagePack serialization as byte vector + + @complexity Linear in the size of the JSON value @a j. + + @liveexample{The example shows the serialization of a JSON value to a byte + vector in MessagePack format.,to_msgpack} + + @sa http://msgpack.org + @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the + analogous deserialization + @sa @ref to_cbor(const basic_json& for the related CBOR format + @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the + related UBJSON format + + @since version 2.0.9 + */ + static std::vector<uint8_t> to_msgpack(const basic_json& j) + { + std::vector<uint8_t> result; + to_msgpack(j, result); + return result; + } + + static void to_msgpack(const basic_json& j, detail::output_adapter<uint8_t> o) + { + binary_writer<uint8_t>(o).write_msgpack(j); + } + + static void to_msgpack(const basic_json& j, detail::output_adapter<char> o) + { + binary_writer<char>(o).write_msgpack(j); + } + + /*! + @brief create a UBJSON serialization of a given JSON value + + Serializes a given JSON value @a j to a byte vector using the UBJSON + (Universal Binary JSON) serialization format. UBJSON aims to be more compact + than JSON itself, yet more efficient to parse. + + The library uses the following mapping from JSON values types to + UBJSON types according to the UBJSON specification: + + JSON value type | value/range | UBJSON type | marker + --------------- | --------------------------------- | ----------- | ------ + null | `null` | null | `Z` + boolean | `true` | true | `T` + boolean | `false` | false | `F` + number_integer | -9223372036854775808..-2147483649 | int64 | `L` + number_integer | -2147483648..-32769 | int32 | `l` + number_integer | -32768..-129 | int16 | `I` + number_integer | -128..127 | int8 | `i` + number_integer | 128..255 | uint8 | `U` + number_integer | 256..32767 | int16 | `I` + number_integer | 32768..2147483647 | int32 | `l` + number_integer | 2147483648..9223372036854775807 | int64 | `L` + number_unsigned | 0..127 | int8 | `i` + number_unsigned | 128..255 | uint8 | `U` + number_unsigned | 256..32767 | int16 | `I` + number_unsigned | 32768..2147483647 | int32 | `l` + number_unsigned | 2147483648..9223372036854775807 | int64 | `L` + number_float | *any value* | float64 | `D` + string | *with shortest length indicator* | string | `S` + array | *see notes on optimized format* | array | `[` + object | *see notes on optimized format* | map | `{` + + @note The mapping is **complete** in the sense that any JSON value type + can be converted to a UBJSON value. + + @note The following values can **not** be converted to a UBJSON value: + - strings with more than 9223372036854775807 bytes (theoretical) + - unsigned integer numbers above 9223372036854775807 + + @note The following markers are not used in the conversion: + - `Z`: no-op values are not created. + - `C`: single-byte strings are serialized with `S` markers. + + @note Any UBJSON output created @ref to_ubjson can be successfully parsed + by @ref from_ubjson. + + @note If NaN or Infinity are stored inside a JSON number, they are + serialized properly. This behavior differs from the @ref dump() + function which serializes NaN or Infinity to `null`. + + @note The optimized formats for containers are supported: Parameter + @a use_size adds size information to the beginning of a container and + removes the closing marker. Parameter @a use_type further checks + whether all elements of a container have the same type and adds the + type marker to the beginning of the container. The @a use_type + parameter must only be used together with @a use_size = true. Note + that @a use_size = true alone may result in larger representations - + the benefit of this parameter is that the receiving side is + immediately informed on the number of elements of the container. + + @param[in] j JSON value to serialize + @param[in] use_size whether to add size annotations to container types + @param[in] use_type whether to add type annotations to container types + (must be combined with @a use_size = true) + @return UBJSON serialization as byte vector + + @complexity Linear in the size of the JSON value @a j. + + @liveexample{The example shows the serialization of a JSON value to a byte + vector in UBJSON format.,to_ubjson} + + @sa http://ubjson.org + @sa @ref from_ubjson(detail::input_adapter, const bool strict) for the + analogous deserialization + @sa @ref to_cbor(const basic_json& for the related CBOR format + @sa @ref to_msgpack(const basic_json&) for the related MessagePack format + + @since version 3.1.0 + */ + static std::vector<uint8_t> to_ubjson(const basic_json& j, + const bool use_size = false, + const bool use_type = false) + { + std::vector<uint8_t> result; + to_ubjson(j, result, use_size, use_type); + return result; + } + + static void to_ubjson(const basic_json& j, detail::output_adapter<uint8_t> o, + const bool use_size = false, const bool use_type = false) + { + binary_writer<uint8_t>(o).write_ubjson(j, use_size, use_type); + } + + static void to_ubjson(const basic_json& j, detail::output_adapter<char> o, + const bool use_size = false, const bool use_type = false) + { + binary_writer<char>(o).write_ubjson(j, use_size, use_type); + } + + /*! + @brief create a JSON value from an input in CBOR format + + Deserializes a given input @a i to a JSON value using the CBOR (Concise + Binary Object Representation) serialization format. + + The library maps CBOR types to JSON value types as follows: + + CBOR type | JSON value type | first byte + ---------------------- | --------------- | ---------- + Integer | number_unsigned | 0x00..0x17 + Unsigned integer | number_unsigned | 0x18 + Unsigned integer | number_unsigned | 0x19 + Unsigned integer | number_unsigned | 0x1A + Unsigned integer | number_unsigned | 0x1B + Negative integer | number_integer | 0x20..0x37 + Negative integer | number_integer | 0x38 + Negative integer | number_integer | 0x39 + Negative integer | number_integer | 0x3A + Negative integer | number_integer | 0x3B + Negative integer | number_integer | 0x40..0x57 + UTF-8 string | string | 0x60..0x77 + UTF-8 string | string | 0x78 + UTF-8 string | string | 0x79 + UTF-8 string | string | 0x7A + UTF-8 string | string | 0x7B + UTF-8 string | string | 0x7F + array | array | 0x80..0x97 + array | array | 0x98 + array | array | 0x99 + array | array | 0x9A + array | array | 0x9B + array | array | 0x9F + map | object | 0xA0..0xB7 + map | object | 0xB8 + map | object | 0xB9 + map | object | 0xBA + map | object | 0xBB + map | object | 0xBF + False | `false` | 0xF4 + True | `true` | 0xF5 + Nill | `null` | 0xF6 + Half-Precision Float | number_float | 0xF9 + Single-Precision Float | number_float | 0xFA + Double-Precision Float | number_float | 0xFB + + @warning The mapping is **incomplete** in the sense that not all CBOR + types can be converted to a JSON value. The following CBOR types + are not supported and will yield parse errors (parse_error.112): + - byte strings (0x40..0x5F) + - date/time (0xC0..0xC1) + - bignum (0xC2..0xC3) + - decimal fraction (0xC4) + - bigfloat (0xC5) + - tagged items (0xC6..0xD4, 0xD8..0xDB) + - expected conversions (0xD5..0xD7) + - simple values (0xE0..0xF3, 0xF8) + - undefined (0xF7) + + @warning CBOR allows map keys of any type, whereas JSON only allows + strings as keys in object values. Therefore, CBOR maps with keys + other than UTF-8 strings are rejected (parse_error.113). + + @note Any CBOR output created @ref to_cbor can be successfully parsed by + @ref from_cbor. + + @param[in] i an input in CBOR format convertible to an input adapter + @param[in] strict whether to expect the input to be consumed until EOF + (true by default) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + + @return deserialized JSON value + + @throw parse_error.110 if the given input ends prematurely or the end of + file was not reached when @a strict was set to true + @throw parse_error.112 if unsupported features from CBOR were + used in the given input @a v or if the input is not valid CBOR + @throw parse_error.113 if a string was expected as map key, but not found + + @complexity Linear in the size of the input @a i. + + @liveexample{The example shows the deserialization of a byte vector in CBOR + format to a JSON value.,from_cbor} + + @sa http://cbor.io + @sa @ref to_cbor(const basic_json&) for the analogous serialization + @sa @ref from_msgpack(detail::input_adapter, const bool, const bool) for the + related MessagePack format + @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for the + related UBJSON format + + @since version 2.0.9; parameter @a start_index since 2.1.1; changed to + consume input adapters, removed start_index parameter, and added + @a strict parameter since 3.0.0; added @allow_exceptions parameter + since 3.2.0 + */ + static basic_json from_cbor(detail::input_adapter&& i, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser<basic_json> sdp(result, allow_exceptions); + const bool res = binary_reader(detail::input_adapter(i)).sax_parse(input_format_t::cbor, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @copydoc from_cbor(detail::input_adapter, const bool, const bool) + */ + template<typename A1, typename A2, + detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0> + static basic_json from_cbor(A1 && a1, A2 && a2, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser<basic_json> sdp(result, allow_exceptions); + const bool res = binary_reader(detail::input_adapter(std::forward<A1>(a1), std::forward<A2>(a2))).sax_parse(input_format_t::cbor, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @brief create a JSON value from an input in MessagePack format + + Deserializes a given input @a i to a JSON value using the MessagePack + serialization format. + + The library maps MessagePack types to JSON value types as follows: + + MessagePack type | JSON value type | first byte + ---------------- | --------------- | ---------- + positive fixint | number_unsigned | 0x00..0x7F + fixmap | object | 0x80..0x8F + fixarray | array | 0x90..0x9F + fixstr | string | 0xA0..0xBF + nil | `null` | 0xC0 + false | `false` | 0xC2 + true | `true` | 0xC3 + float 32 | number_float | 0xCA + float 64 | number_float | 0xCB + uint 8 | number_unsigned | 0xCC + uint 16 | number_unsigned | 0xCD + uint 32 | number_unsigned | 0xCE + uint 64 | number_unsigned | 0xCF + int 8 | number_integer | 0xD0 + int 16 | number_integer | 0xD1 + int 32 | number_integer | 0xD2 + int 64 | number_integer | 0xD3 + str 8 | string | 0xD9 + str 16 | string | 0xDA + str 32 | string | 0xDB + array 16 | array | 0xDC + array 32 | array | 0xDD + map 16 | object | 0xDE + map 32 | object | 0xDF + negative fixint | number_integer | 0xE0-0xFF + + @warning The mapping is **incomplete** in the sense that not all + MessagePack types can be converted to a JSON value. The following + MessagePack types are not supported and will yield parse errors: + - bin 8 - bin 32 (0xC4..0xC6) + - ext 8 - ext 32 (0xC7..0xC9) + - fixext 1 - fixext 16 (0xD4..0xD8) + + @note Any MessagePack output created @ref to_msgpack can be successfully + parsed by @ref from_msgpack. + + @param[in] i an input in MessagePack format convertible to an input + adapter + @param[in] strict whether to expect the input to be consumed until EOF + (true by default) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + + @return deserialized JSON value + + @throw parse_error.110 if the given input ends prematurely or the end of + file was not reached when @a strict was set to true + @throw parse_error.112 if unsupported features from MessagePack were + used in the given input @a i or if the input is not valid MessagePack + @throw parse_error.113 if a string was expected as map key, but not found + + @complexity Linear in the size of the input @a i. + + @liveexample{The example shows the deserialization of a byte vector in + MessagePack format to a JSON value.,from_msgpack} + + @sa http://msgpack.org + @sa @ref to_msgpack(const basic_json&) for the analogous serialization + @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the + related CBOR format + @sa @ref from_ubjson(detail::input_adapter, const bool, const bool) for + the related UBJSON format + + @since version 2.0.9; parameter @a start_index since 2.1.1; changed to + consume input adapters, removed start_index parameter, and added + @a strict parameter since 3.0.0; added @allow_exceptions parameter + since 3.2.0 + */ + static basic_json from_msgpack(detail::input_adapter&& i, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser<basic_json> sdp(result, allow_exceptions); + const bool res = binary_reader(detail::input_adapter(i)).sax_parse(input_format_t::msgpack, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @copydoc from_msgpack(detail::input_adapter, const bool, const bool) + */ + template<typename A1, typename A2, + detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0> + static basic_json from_msgpack(A1 && a1, A2 && a2, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser<basic_json> sdp(result, allow_exceptions); + const bool res = binary_reader(detail::input_adapter(std::forward<A1>(a1), std::forward<A2>(a2))).sax_parse(input_format_t::msgpack, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @brief create a JSON value from an input in UBJSON format + + Deserializes a given input @a i to a JSON value using the UBJSON (Universal + Binary JSON) serialization format. + + The library maps UBJSON types to JSON value types as follows: + + UBJSON type | JSON value type | marker + ----------- | --------------------------------------- | ------ + no-op | *no value, next value is read* | `N` + null | `null` | `Z` + false | `false` | `F` + true | `true` | `T` + float32 | number_float | `d` + float64 | number_float | `D` + uint8 | number_unsigned | `U` + int8 | number_integer | `i` + int16 | number_integer | `I` + int32 | number_integer | `l` + int64 | number_integer | `L` + string | string | `S` + char | string | `C` + array | array (optimized values are supported) | `[` + object | object (optimized values are supported) | `{` + + @note The mapping is **complete** in the sense that any UBJSON value can + be converted to a JSON value. + + @param[in] i an input in UBJSON format convertible to an input adapter + @param[in] strict whether to expect the input to be consumed until EOF + (true by default) + @param[in] allow_exceptions whether to throw exceptions in case of a + parse error (optional, true by default) + + @return deserialized JSON value + + @throw parse_error.110 if the given input ends prematurely or the end of + file was not reached when @a strict was set to true + @throw parse_error.112 if a parse error occurs + @throw parse_error.113 if a string could not be parsed successfully + + @complexity Linear in the size of the input @a i. + + @liveexample{The example shows the deserialization of a byte vector in + UBJSON format to a JSON value.,from_ubjson} + + @sa http://ubjson.org + @sa @ref to_ubjson(const basic_json&, const bool, const bool) for the + analogous serialization + @sa @ref from_cbor(detail::input_adapter, const bool, const bool) for the + related CBOR format + @sa @ref from_msgpack(detail::input_adapter, const bool, const bool) for + the related MessagePack format + + @since version 3.1.0; added @allow_exceptions parameter since 3.2.0 + */ + static basic_json from_ubjson(detail::input_adapter&& i, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser<basic_json> sdp(result, allow_exceptions); + const bool res = binary_reader(detail::input_adapter(i)).sax_parse(input_format_t::ubjson, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + /*! + @copydoc from_ubjson(detail::input_adapter, const bool, const bool) + */ + template<typename A1, typename A2, + detail::enable_if_t<std::is_constructible<detail::input_adapter, A1, A2>::value, int> = 0> + static basic_json from_ubjson(A1 && a1, A2 && a2, + const bool strict = true, + const bool allow_exceptions = true) + { + basic_json result; + detail::json_sax_dom_parser<basic_json> sdp(result, allow_exceptions); + const bool res = binary_reader(detail::input_adapter(std::forward<A1>(a1), std::forward<A2>(a2))).sax_parse(input_format_t::ubjson, &sdp, strict); + return res ? result : basic_json(value_t::discarded); + } + + /// @} + + ////////////////////////// + // JSON Pointer support // + ////////////////////////// + + /// @name JSON Pointer functions + /// @{ + + /*! + @brief access specified element via JSON Pointer + + Uses a JSON pointer to retrieve a reference to the respective JSON value. + No bound checking is performed. Similar to @ref operator[](const typename + object_t::key_type&), `null` values are created in arrays and objects if + necessary. + + In particular: + - If the JSON pointer points to an object key that does not exist, it + is created an filled with a `null` value before a reference to it + is returned. + - If the JSON pointer points to an array index that does not exist, it + is created an filled with a `null` value before a reference to it + is returned. All indices between the current maximum and the given + index are also filled with `null`. + - The special value `-` is treated as a synonym for the index past the + end. + + @param[in] ptr a JSON pointer + + @return reference to the element pointed to by @a ptr + + @complexity Constant. + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.404 if the JSON pointer can not be resolved + + @liveexample{The behavior is shown in the example.,operatorjson_pointer} + + @since version 2.0.0 + */ + reference operator[](const json_pointer& ptr) + { + return ptr.get_unchecked(this); + } + + /*! + @brief access specified element via JSON Pointer + + Uses a JSON pointer to retrieve a reference to the respective JSON value. + No bound checking is performed. The function does not change the JSON + value; no `null` values are created. In particular, the the special value + `-` yields an exception. + + @param[in] ptr JSON pointer to the desired element + + @return const reference to the element pointed to by @a ptr + + @complexity Constant. + + @throw parse_error.106 if an array index begins with '0' + @throw parse_error.109 if an array index was not a number + @throw out_of_range.402 if the array index '-' is used + @throw out_of_range.404 if the JSON pointer can not be resolved + + @liveexample{The behavior is shown in the example.,operatorjson_pointer_const} + + @since version 2.0.0 + */ + const_reference operator[](const json_pointer& ptr) const + { + return ptr.get_unchecked(this); + } + + /*! + @brief access specified element via JSON Pointer + + Returns a reference to the element at with specified JSON pointer @a ptr, + with bounds checking. + + @param[in] ptr JSON pointer to the desired element + + @return reference to the element pointed to by @a ptr + + @throw parse_error.106 if an array index in the passed JSON pointer @a ptr + begins with '0'. See example below. + + @throw parse_error.109 if an array index in the passed JSON pointer @a ptr + is not a number. See example below. + + @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr + is out of range. See example below. + + @throw out_of_range.402 if the array index '-' is used in the passed JSON + pointer @a ptr. As `at` provides checked access (and no elements are + implicitly inserted), the index '-' is always invalid. See example below. + + @throw out_of_range.403 if the JSON pointer describes a key of an object + which cannot be found. See example below. + + @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved. + See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 2.0.0 + + @liveexample{The behavior is shown in the example.,at_json_pointer} + */ + reference at(const json_pointer& ptr) + { + return ptr.get_checked(this); + } + + /*! + @brief access specified element via JSON Pointer + + Returns a const reference to the element at with specified JSON pointer @a + ptr, with bounds checking. + + @param[in] ptr JSON pointer to the desired element + + @return reference to the element pointed to by @a ptr + + @throw parse_error.106 if an array index in the passed JSON pointer @a ptr + begins with '0'. See example below. + + @throw parse_error.109 if an array index in the passed JSON pointer @a ptr + is not a number. See example below. + + @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr + is out of range. See example below. + + @throw out_of_range.402 if the array index '-' is used in the passed JSON + pointer @a ptr. As `at` provides checked access (and no elements are + implicitly inserted), the index '-' is always invalid. See example below. + + @throw out_of_range.403 if the JSON pointer describes a key of an object + which cannot be found. See example below. + + @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved. + See example below. + + @exceptionsafety Strong guarantee: if an exception is thrown, there are no + changes in the JSON value. + + @complexity Constant. + + @since version 2.0.0 + + @liveexample{The behavior is shown in the example.,at_json_pointer_const} + */ + const_reference at(const json_pointer& ptr) const + { + return ptr.get_checked(this); + } + + /*! + @brief return flattened JSON value + + The function creates a JSON object whose keys are JSON pointers (see [RFC + 6901](https://tools.ietf.org/html/rfc6901)) and whose values are all + primitive. The original JSON value can be restored using the @ref + unflatten() function. + + @return an object that maps JSON pointers to primitive values + + @note Empty objects and arrays are flattened to `null` and will not be + reconstructed correctly by the @ref unflatten() function. + + @complexity Linear in the size the JSON value. + + @liveexample{The following code shows how a JSON object is flattened to an + object whose keys consist of JSON pointers.,flatten} + + @sa @ref unflatten() for the reverse function + + @since version 2.0.0 + */ + basic_json flatten() const + { + basic_json result(value_t::object); + json_pointer::flatten("", *this, result); + return result; + } + + /*! + @brief unflatten a previously flattened JSON value + + The function restores the arbitrary nesting of a JSON value that has been + flattened before using the @ref flatten() function. The JSON value must + meet certain constraints: + 1. The value must be an object. + 2. The keys must be JSON pointers (see + [RFC 6901](https://tools.ietf.org/html/rfc6901)) + 3. The mapped values must be primitive JSON types. + + @return the original JSON from a flattened version + + @note Empty objects and arrays are flattened by @ref flatten() to `null` + values and can not unflattened to their original type. Apart from + this example, for a JSON value `j`, the following is always true: + `j == j.flatten().unflatten()`. + + @complexity Linear in the size the JSON value. + + @throw type_error.314 if value is not an object + @throw type_error.315 if object values are not primitive + + @liveexample{The following code shows how a flattened JSON object is + unflattened into the original nested JSON object.,unflatten} + + @sa @ref flatten() for the reverse function + + @since version 2.0.0 + */ + basic_json unflatten() const + { + return json_pointer::unflatten(*this); + } + + /// @} + + ////////////////////////// + // JSON Patch functions // + ////////////////////////// + + /// @name JSON Patch functions + /// @{ + + /*! + @brief applies a JSON patch + + [JSON Patch](http://jsonpatch.com) defines a JSON document structure for + expressing a sequence of operations to apply to a JSON) document. With + this function, a JSON Patch is applied to the current JSON value by + executing all operations from the patch. + + @param[in] json_patch JSON patch document + @return patched document + + @note The application of a patch is atomic: Either all operations succeed + and the patched document is returned or an exception is thrown. In + any case, the original value is not changed: the patch is applied + to a copy of the value. + + @throw parse_error.104 if the JSON patch does not consist of an array of + objects + + @throw parse_error.105 if the JSON patch is malformed (e.g., mandatory + attributes are missing); example: `"operation add must have member path"` + + @throw out_of_range.401 if an array index is out of range. + + @throw out_of_range.403 if a JSON pointer inside the patch could not be + resolved successfully in the current JSON value; example: `"key baz not + found"` + + @throw out_of_range.405 if JSON pointer has no parent ("add", "remove", + "move") + + @throw other_error.501 if "test" operation was unsuccessful + + @complexity Linear in the size of the JSON value and the length of the + JSON patch. As usually only a fraction of the JSON value is affected by + the patch, the complexity can usually be neglected. + + @liveexample{The following code shows how a JSON patch is applied to a + value.,patch} + + @sa @ref diff -- create a JSON patch by comparing two JSON values + + @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902) + @sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901) + + @since version 2.0.0 + */ + basic_json patch(const basic_json& json_patch) const + { + // make a working copy to apply the patch to + basic_json result = *this; + + // the valid JSON Patch operations + enum class patch_operations {add, remove, replace, move, copy, test, invalid}; + + const auto get_op = [](const std::string & op) + { + if (op == "add") + { + return patch_operations::add; + } + if (op == "remove") + { + return patch_operations::remove; + } + if (op == "replace") + { + return patch_operations::replace; + } + if (op == "move") + { + return patch_operations::move; + } + if (op == "copy") + { + return patch_operations::copy; + } + if (op == "test") + { + return patch_operations::test; + } + + return patch_operations::invalid; + }; + + // wrapper for "add" operation; add value at ptr + const auto operation_add = [&result](json_pointer & ptr, basic_json val) + { + // adding to the root of the target document means replacing it + if (ptr.is_root()) + { + result = val; + } + else + { + // make sure the top element of the pointer exists + json_pointer top_pointer = ptr.top(); + if (top_pointer != ptr) + { + result.at(top_pointer); + } + + // get reference to parent of JSON pointer ptr + const auto last_path = ptr.pop_back(); + basic_json& parent = result[ptr]; + + switch (parent.m_type) + { + case value_t::null: + case value_t::object: + { + // use operator[] to add value + parent[last_path] = val; + break; + } + + case value_t::array: + { + if (last_path == "-") + { + // special case: append to back + parent.push_back(val); + } + else + { + const auto idx = json_pointer::array_index(last_path); + if (JSON_UNLIKELY(static_cast<size_type>(idx) > parent.size())) + { + // avoid undefined behavior + JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); + } + else + { + // default case: insert add offset + parent.insert(parent.begin() + static_cast<difference_type>(idx), val); + } + } + break; + } + + default: + { + // if there exists a parent it cannot be primitive + assert(false); // LCOV_EXCL_LINE + } + } + } + }; + + // wrapper for "remove" operation; remove value at ptr + const auto operation_remove = [&result](json_pointer & ptr) + { + // get reference to parent of JSON pointer ptr + const auto last_path = ptr.pop_back(); + basic_json& parent = result.at(ptr); + + // remove child + if (parent.is_object()) + { + // perform range check + auto it = parent.find(last_path); + if (JSON_LIKELY(it != parent.end())) + { + parent.erase(it); + } + else + { + JSON_THROW(out_of_range::create(403, "key '" + last_path + "' not found")); + } + } + else if (parent.is_array()) + { + // note erase performs range check + parent.erase(static_cast<size_type>(json_pointer::array_index(last_path))); + } + }; + + // type check: top level value must be an array + if (JSON_UNLIKELY(not json_patch.is_array())) + { + JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects")); + } + + // iterate and apply the operations + for (const auto& val : json_patch) + { + // wrapper to get a value for an operation + const auto get_value = [&val](const std::string & op, + const std::string & member, + bool string_type) -> basic_json & + { + // find value + auto it = val.m_value.object->find(member); + + // context-sensitive error message + const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'"; + + // check if desired value is present + if (JSON_UNLIKELY(it == val.m_value.object->end())) + { + JSON_THROW(parse_error::create(105, 0, error_msg + " must have member '" + member + "'")); + } + + // check if result is of type string + if (JSON_UNLIKELY(string_type and not it->second.is_string())) + { + JSON_THROW(parse_error::create(105, 0, error_msg + " must have string member '" + member + "'")); + } + + // no error: return value + return it->second; + }; + + // type check: every element of the array must be an object + if (JSON_UNLIKELY(not val.is_object())) + { + JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects")); + } + + // collect mandatory members + const std::string op = get_value("op", "op", true); + const std::string path = get_value(op, "path", true); + json_pointer ptr(path); + + switch (get_op(op)) + { + case patch_operations::add: + { + operation_add(ptr, get_value("add", "value", false)); + break; + } + + case patch_operations::remove: + { + operation_remove(ptr); + break; + } + + case patch_operations::replace: + { + // the "path" location must exist - use at() + result.at(ptr) = get_value("replace", "value", false); + break; + } + + case patch_operations::move: + { + const std::string from_path = get_value("move", "from", true); + json_pointer from_ptr(from_path); + + // the "from" location must exist - use at() + basic_json v = result.at(from_ptr); + + // The move operation is functionally identical to a + // "remove" operation on the "from" location, followed + // immediately by an "add" operation at the target + // location with the value that was just removed. + operation_remove(from_ptr); + operation_add(ptr, v); + break; + } + + case patch_operations::copy: + { + const std::string from_path = get_value("copy", "from", true); + const json_pointer from_ptr(from_path); + + // the "from" location must exist - use at() + basic_json v = result.at(from_ptr); + + // The copy is functionally identical to an "add" + // operation at the target location using the value + // specified in the "from" member. + operation_add(ptr, v); + break; + } + + case patch_operations::test: + { + bool success = false; + JSON_TRY + { + // check if "value" matches the one at "path" + // the "path" location must exist - use at() + success = (result.at(ptr) == get_value("test", "value", false)); + } + JSON_CATCH (out_of_range&) + { + // ignore out of range errors: success remains false + } + + // throw an exception if test fails + if (JSON_UNLIKELY(not success)) + { + JSON_THROW(other_error::create(501, "unsuccessful: " + val.dump())); + } + + break; + } + + case patch_operations::invalid: + { + // op must be "add", "remove", "replace", "move", "copy", or + // "test" + JSON_THROW(parse_error::create(105, 0, "operation value '" + op + "' is invalid")); + } + } + } + + return result; + } + + /*! + @brief creates a diff as a JSON patch + + Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can + be changed into the value @a target by calling @ref patch function. + + @invariant For two JSON values @a source and @a target, the following code + yields always `true`: + @code {.cpp} + source.patch(diff(source, target)) == target; + @endcode + + @note Currently, only `remove`, `add`, and `replace` operations are + generated. + + @param[in] source JSON value to compare from + @param[in] target JSON value to compare against + @param[in] path helper value to create JSON pointers + + @return a JSON patch to convert the @a source to @a target + + @complexity Linear in the lengths of @a source and @a target. + + @liveexample{The following code shows how a JSON patch is created as a + diff for two JSON values.,diff} + + @sa @ref patch -- apply a JSON patch + @sa @ref merge_patch -- apply a JSON Merge Patch + + @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902) + + @since version 2.0.0 + */ + static basic_json diff(const basic_json& source, const basic_json& target, + const std::string& path = "") + { + // the patch + basic_json result(value_t::array); + + // if the values are the same, return empty patch + if (source == target) + { + return result; + } + + if (source.type() != target.type()) + { + // different types: replace value + result.push_back( + { + {"op", "replace"}, {"path", path}, {"value", target} + }); + } + else + { + switch (source.type()) + { + case value_t::array: + { + // first pass: traverse common elements + std::size_t i = 0; + while (i < source.size() and i < target.size()) + { + // recursive call to compare array values at index i + auto temp_diff = diff(source[i], target[i], path + "/" + std::to_string(i)); + result.insert(result.end(), temp_diff.begin(), temp_diff.end()); + ++i; + } + + // i now reached the end of at least one array + // in a second pass, traverse the remaining elements + + // remove my remaining elements + const auto end_index = static_cast<difference_type>(result.size()); + while (i < source.size()) + { + // add operations in reverse order to avoid invalid + // indices + result.insert(result.begin() + end_index, object( + { + {"op", "remove"}, + {"path", path + "/" + std::to_string(i)} + })); + ++i; + } + + // add other remaining elements + while (i < target.size()) + { + result.push_back( + { + {"op", "add"}, + {"path", path + "/" + std::to_string(i)}, + {"value", target[i]} + }); + ++i; + } + + break; + } + + case value_t::object: + { + // first pass: traverse this object's elements + for (auto it = source.cbegin(); it != source.cend(); ++it) + { + // escape the key name to be used in a JSON patch + const auto key = json_pointer::escape(it.key()); + + if (target.find(it.key()) != target.end()) + { + // recursive call to compare object values at key it + auto temp_diff = diff(it.value(), target[it.key()], path + "/" + key); + result.insert(result.end(), temp_diff.begin(), temp_diff.end()); + } + else + { + // found a key that is not in o -> remove it + result.push_back(object( + { + {"op", "remove"}, {"path", path + "/" + key} + })); + } + } + + // second pass: traverse other object's elements + for (auto it = target.cbegin(); it != target.cend(); ++it) + { + if (source.find(it.key()) == source.end()) + { + // found a key that is not in this -> add it + const auto key = json_pointer::escape(it.key()); + result.push_back( + { + {"op", "add"}, {"path", path + "/" + key}, + {"value", it.value()} + }); + } + } + + break; + } + + default: + { + // both primitive type: replace value + result.push_back( + { + {"op", "replace"}, {"path", path}, {"value", target} + }); + break; + } + } + } + + return result; + } + + /// @} + + //////////////////////////////// + // JSON Merge Patch functions // + //////////////////////////////// + + /// @name JSON Merge Patch functions + /// @{ + + /*! + @brief applies a JSON Merge Patch + + The merge patch format is primarily intended for use with the HTTP PATCH + method as a means of describing a set of modifications to a target + resource's content. This function applies a merge patch to the current + JSON value. + + The function implements the following algorithm from Section 2 of + [RFC 7396 (JSON Merge Patch)](https://tools.ietf.org/html/rfc7396): + + ``` + define MergePatch(Target, Patch): + if Patch is an Object: + if Target is not an Object: + Target = {} // Ignore the contents and set it to an empty Object + for each Name/Value pair in Patch: + if Value is null: + if Name exists in Target: + remove the Name/Value pair from Target + else: + Target[Name] = MergePatch(Target[Name], Value) + return Target + else: + return Patch + ``` + + Thereby, `Target` is the current object; that is, the patch is applied to + the current value. + + @param[in] patch the patch to apply + + @complexity Linear in the lengths of @a patch. + + @liveexample{The following code shows how a JSON Merge Patch is applied to + a JSON document.,merge_patch} + + @sa @ref patch -- apply a JSON patch + @sa [RFC 7396 (JSON Merge Patch)](https://tools.ietf.org/html/rfc7396) + + @since version 3.0.0 + */ + void merge_patch(const basic_json& patch) + { + if (patch.is_object()) + { + if (not is_object()) + { + *this = object(); + } + for (auto it = patch.begin(); it != patch.end(); ++it) + { + if (it.value().is_null()) + { + erase(it.key()); + } + else + { + operator[](it.key()).merge_patch(it.value()); + } + } + } + else + { + *this = patch; + } + } + + /// @} +}; +} // namespace nlohmann + +/////////////////////// +// nonmember support // +/////////////////////// + +// specialization of std::swap, and std::hash +namespace std +{ +/*! +@brief exchanges the values of two JSON objects + +@since version 1.0.0 +*/ +template<> +inline void swap<nlohmann::json>(nlohmann::json& j1, nlohmann::json& j2) noexcept( + is_nothrow_move_constructible<nlohmann::json>::value and + is_nothrow_move_assignable<nlohmann::json>::value +) +{ + j1.swap(j2); +} + +/// hash value for JSON objects +template<> +struct hash<nlohmann::json> +{ + /*! + @brief return a hash value for a JSON object + + @since version 1.0.0 + */ + std::size_t operator()(const nlohmann::json& j) const + { + // a naive hashing via the string representation + const auto& h = hash<nlohmann::json::string_t>(); + return h(j.dump()); + } +}; + +/// specialization for std::less<value_t> +/// @note: do not remove the space after '<', +/// see https://github.com/nlohmann/json/pull/679 +template<> +struct less< ::nlohmann::detail::value_t> +{ + /*! + @brief compare two value_t enum values + @since version 3.0.0 + */ + bool operator()(nlohmann::detail::value_t lhs, + nlohmann::detail::value_t rhs) const noexcept + { + return nlohmann::detail::operator<(lhs, rhs); + } +}; + +} // namespace std + +/*! +@brief user-defined string literal for JSON values + +This operator implements a user-defined string literal for JSON objects. It +can be used by adding `"_json"` to a string literal and returns a JSON object +if no parse error occurred. + +@param[in] s a string representation of a JSON object +@param[in] n the length of string @a s +@return a JSON object + +@since version 1.0.0 +*/ +inline nlohmann::json operator "" _json(const char* s, std::size_t n) +{ + return nlohmann::json::parse(s, s + n); +} + +/*! +@brief user-defined string literal for JSON pointer + +This operator implements a user-defined string literal for JSON Pointers. It +can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer +object if no parse error occurred. + +@param[in] s a string representation of a JSON Pointer +@param[in] n the length of string @a s +@return a JSON pointer object + +@since version 2.0.0 +*/ +inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n) +{ + return nlohmann::json::json_pointer(std::string(s, n)); +} + +// #include <nlohmann/detail/macro_unscope.hpp> + + +// restore GCC/clang diagnostic settings +#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) + #pragma GCC diagnostic pop +#endif +#if defined(__clang__) + #pragma GCC diagnostic pop +#endif + +// clean up +#undef JSON_CATCH +#undef JSON_THROW +#undef JSON_TRY +#undef JSON_LIKELY +#undef JSON_UNLIKELY +#undef JSON_DEPRECATED +#undef JSON_HAS_CPP_14 +#undef JSON_HAS_CPP_17 +#undef NLOHMANN_BASIC_JSON_TPL_DECLARATION +#undef NLOHMANN_BASIC_JSON_TPL +#undef NLOHMANN_JSON_HAS_HELPER + + +#endif diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6a0afb3ebdafedc26379432edcae7ee373367894 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,13 @@ +Hcana tests +=========== + +## Current tests: + +- ep elastic tests + +## Tests to add: + +- Start time check +- Focal plane times test +- "Tracking efficiency" test +- Invariant mass check (jpsi) diff --git a/tests/elastic_coin_replay.cxx b/tests/elastic_coin_replay.cxx new file mode 100644 index 0000000000000000000000000000000000000000..7011fa8a309be4d7572aaf931f7ac7df1496ea50 --- /dev/null +++ b/tests/elastic_coin_replay.cxx @@ -0,0 +1,296 @@ +#include <fmt/core.h> +#include <fmt/ostream.h> +#include <vector> + +#include "TString.h" + +R__LOAD_LIBRARY(libHallC.so) +#include "hcana/HallC_Data.h" +#include "DecData.h" +//R__LOAD_LIBRARY(libScandalizer.so) +//#include "monitor/DetectorDisplay.h" +//#include "monitor/DisplayPlots.h" +//#include "monitor/MonitoringDisplay.h" +//#include "scandalizer/PostProcessors.h" +//#include "scandalizer/ScriptHelpers.h" +// +//#include "THaPostProcess.h" +//#include "monitor/ExperimentMonitor.h" +//#include "scandalizer/PostProcessors.h" +#include "THcAnalyzer.h" +#include "THaCut.h" +#include "THcGlobals.h" +#include "THcHallCSpectrometer.h" +#include "THcDetectorMap.h" +#include "THcCherenkov.h" +#include "THcDC.h" +#include "THcHodoscope.h" +#include "THcParmList.h" +#include "THaGoldenTrack.h" +#include "THcHodoEff.h" +#include "THcScalerEvtHandler.h" +#include "THcShower.h" +#include "THcReactionPoint.h" +#include "THcExtTarCor.h" +#include "THcRasteredBeam.h" +#include "THcRun.h" +#include "THcCoinTime.h" +#include "THcConfigEvtHandler.h" +#include "THcTrigDet.h" +#include "THcTrigApp.h" +#include "THcSecondaryKine.h" +#include "THcAerogel.h" +#include "THcPrimaryKine.h" +#include "THaReactionPoint.h" + + + +void elastic_coin_replay(Int_t RunNumber = 0, Int_t MaxEvent = -1) { + using namespace std; + + // Get RunNumber and MaxEvent if not provided. + if( RunNumber<=0 ) { + std::exit(-1); + } + + // Create file name patterns. + const char* RunFileNamePattern = "coin_all_%05d.dat"; + vector<TString> pathList; + pathList.push_back("."); + pathList.push_back("./raw"); + pathList.push_back("./raw/../raw.copiedtotape"); + pathList.push_back("./cache"); + + //const char* RunFileNamePattern = "raw/coin_all_%05d.dat"; + const char* ROOTFileNamePattern = "ROOTfiles/coin_replay_production_%d_%d.root"; + + // Load global parameters + gHcParms->Define("gen_run_number", "Run Number", RunNumber); + gHcParms->AddString("g_ctp_database_filename", "DBASE/COIN/standard.database"); + gHcParms->Load(gHcParms->GetString("g_ctp_database_filename"), RunNumber); + gHcParms->Load(gHcParms->GetString("g_ctp_parm_filename")); + gHcParms->Load(gHcParms->GetString("g_ctp_kinematics_filename"), RunNumber); + // Load params for COIN trigger configuration + gHcParms->Load("PARAM/TRIG/tcoin.param"); + // Load fadc debug parameters + gHcParms->Load("PARAM/HMS/GEN/h_fadc_debug.param"); + gHcParms->Load("PARAM/SHMS/GEN/p_fadc_debug.param"); + + // const char* CurrentFileNamePattern = "low_curr_bcm/bcmcurrent_%d.param"; + // gHcParms->Load(Form(CurrentFileNamePattern, RunNumber)); + + // Load the Hall C detector map + gHcDetectorMap = new THcDetectorMap(); + gHcDetectorMap->Load("MAPS/COIN/DETEC/coin.map"); + + // Dec data + gHaApps->Add(new Podd::DecData("D","Decoder raw data")); + //=:=:=:= + // SHMS + //=:=:=:= + + // Set up the equipment to be analyzed. + THcHallCSpectrometer* SHMS = new THcHallCSpectrometer("P", "SHMS"); + SHMS->SetEvtType(1); + SHMS->AddEvtType(4); + SHMS->AddEvtType(5); + SHMS->AddEvtType(6); + SHMS->AddEvtType(7); + gHaApps->Add(SHMS); + // Add Noble Gas Cherenkov to SHMS apparatus + THcCherenkov* pngcer = new THcCherenkov("ngcer", "Noble Gas Cherenkov"); + SHMS->AddDetector(pngcer); + // Add drift chambers to SHMS apparatus + THcDC* pdc = new THcDC("dc", "Drift Chambers"); + SHMS->AddDetector(pdc); + // Add hodoscope to SHMS apparatus + THcHodoscope* phod = new THcHodoscope("hod", "Hodoscope"); + SHMS->AddDetector(phod); + // Add Heavy Gas Cherenkov to SHMS apparatus + THcCherenkov* phgcer = new THcCherenkov("hgcer", "Heavy Gas Cherenkov"); + SHMS->AddDetector(phgcer); + // Add Aerogel Cherenkov to SHMS apparatus + THcAerogel* paero = new THcAerogel("aero", "Aerogel"); + SHMS->AddDetector(paero); + // Add calorimeter to SHMS apparatus + THcShower* pcal = new THcShower("cal", "Calorimeter"); + SHMS->AddDetector(pcal); + + // THcBCMCurrent* hbc = new THcBCMCurrent("H.bcm", "BCM current check"); + // gHaPhysics->Add(hbc); + + // Add rastered beam apparatus + THaApparatus* pbeam = new THcRasteredBeam("P.rb", "Rastered Beamline"); + gHaApps->Add(pbeam); + // Add physics modules + // Calculate reaction point + THcReactionPoint* prp = new THcReactionPoint("P.react", "SHMS reaction point", "P", "P.rb"); + gHaPhysics->Add(prp); + // Calculate extended target corrections + THcExtTarCor* pext = new THcExtTarCor("P.extcor", "HMS extended target corrections", "P", "P.react"); + gHaPhysics->Add(pext); + // Calculate golden track quantites + THaGoldenTrack* pgtr = new THaGoldenTrack("P.gtr", "SHMS Golden Track", "P"); + gHaPhysics->Add(pgtr); + // Calculate the hodoscope efficiencies + THcHodoEff* peff = new THcHodoEff("phodeff", "SHMS hodo efficiency", "P.hod"); + gHaPhysics->Add(peff); + + // Add event handler for scaler events + THcScalerEvtHandler* pscaler = new THcScalerEvtHandler("P", "Hall C scaler event type 1"); + pscaler->AddEvtType(1); + pscaler->AddEvtType(4); + pscaler->AddEvtType(5); + pscaler->AddEvtType(6); + pscaler->AddEvtType(7); + pscaler->AddEvtType(129); + pscaler->SetDelayedType(129); + pscaler->SetUseFirstEvent(kTRUE); + gHaEvtHandlers->Add(pscaler); + + //=:=:= + // HMS + //=:=:= + + // Set up the equipment to be analyzed. + THcHallCSpectrometer* HMS = new THcHallCSpectrometer("H", "HMS"); + HMS->SetEvtType(2); + HMS->AddEvtType(4); + HMS->AddEvtType(5); + HMS->AddEvtType(6); + HMS->AddEvtType(7); + gHaApps->Add(HMS); + // Add drift chambers to HMS apparatus + THcDC* hdc = new THcDC("dc", "Drift Chambers"); + HMS->AddDetector(hdc); + // Add hodoscope to HMS apparatus + THcHodoscope* hhod = new THcHodoscope("hod", "Hodoscope"); + HMS->AddDetector(hhod); + // Add Cherenkov to HMS apparatus + THcCherenkov* hcer = new THcCherenkov("cer", "Heavy Gas Cherenkov"); + HMS->AddDetector(hcer); + // Add Aerogel Cherenkov to HMS apparatus + // THcAerogel* haero = new THcAerogel("aero", "Aerogel"); + // HMS->AddDetector(haero); + // Add calorimeter to HMS apparatus + THcShower* hcal = new THcShower("cal", "Calorimeter"); + HMS->AddDetector(hcal); + + // Add rastered beam apparatus + THaApparatus* hbeam = new THcRasteredBeam("H.rb", "Rastered Beamline"); + gHaApps->Add(hbeam); + // Add physics modules + // Calculate reaction point + THcReactionPoint* hrp = new THcReactionPoint("H.react", "HMS reaction point", "H", "H.rb"); + gHaPhysics->Add(hrp); + // Calculate extended target corrections + THcExtTarCor* hext = new THcExtTarCor("H.extcor", "HMS extended target corrections", "H", "H.react"); + gHaPhysics->Add(hext); + // Calculate golden track quantities + THaGoldenTrack* hgtr = new THaGoldenTrack("H.gtr", "HMS Golden Track", "H"); + gHaPhysics->Add(hgtr); + // Calculate the hodoscope efficiencies + THcHodoEff* heff = new THcHodoEff("hhodeff", "HMS hodo efficiency", "H.hod"); + gHaPhysics->Add(heff); + + // Add event handler for scaler events + THcScalerEvtHandler *hscaler = new THcScalerEvtHandler("H", "Hall C scaler event type 4"); + hscaler->AddEvtType(2); + hscaler->AddEvtType(4); + hscaler->AddEvtType(5); + hscaler->AddEvtType(6); + hscaler->AddEvtType(7); + hscaler->AddEvtType(129); + hscaler->SetDelayedType(129); + hscaler->SetUseFirstEvent(kTRUE); + gHaEvtHandlers->Add(hscaler); + + //=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:= + // Kinematics Modules + //=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:= + + // Add Physics Module to calculate primary (scattered electrons) beam kinematics + THcPrimaryKine* hkin_primary = new THcPrimaryKine("H.kin.primary", "HMS Single Arm Kinematics", "H", "H.rb"); + gHaPhysics->Add(hkin_primary); + // Add Physics Module to calculate secondary (scattered hadrons) beam kinematics + THcSecondaryKine* pkin_secondary = new THcSecondaryKine("P.kin.secondary", "SHMS Single Arm Kinematics", "P", "H.kin.primary"); + gHaPhysics->Add(pkin_secondary); + + //=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:= + // Global Objects & Event Handlers + //=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:=:= + + // Add trigger apparatus + THaApparatus* TRG = new THcTrigApp("T", "TRG"); + gHaApps->Add(TRG); + // Add trigger detector to trigger apparatus + THcTrigDet* coin = new THcTrigDet("coin", "Coincidence Trigger Information"); + // Suppress missing reference time warnings for these event types + coin->SetEvtType(1); + coin->AddEvtType(2); + TRG->AddDetector(coin); + + + //Add coin physics module THcCoinTime::THcCoinTime (const char *name, const char* description, const char* hadArmName, + // const char* elecArmName, const char* coinname) : + THcCoinTime* coinTime = new THcCoinTime("CTime", "Coincidende Time Determination", "P", "H", "T.coin"); + gHaPhysics->Add(coinTime); + + // Add event handler for prestart event 125. + THcConfigEvtHandler* ev125 = new THcConfigEvtHandler("HC", "Config Event type 125"); + gHaEvtHandlers->Add(ev125); + // Add event handler for EPICS events + THaEpicsEvtHandler* hcepics = new THaEpicsEvtHandler("epics", "HC EPICS event type 180"); + gHaEvtHandlers->Add(hcepics); + + // Set up the analyzer - we use the standard one, + // but this could be an experiment-specific one as well. + // The Analyzer controls the reading of the data, executes + // tests/cuts, loops over Acpparatus's and PhysicsModules, + // and executes the output routines. + THcAnalyzer* analyzer = new THcAnalyzer; + + // A simple event class to be output to the resulting tree. + // Creating your own descendant of THaEvent is one way of + // defining and controlling the output. + THaEvent* event = new THaEvent; + + // Define the run(s) that we want to analyze. + // We just set up one, but this could be many. + THcRun* run = new THcRun( pathList, Form(RunFileNamePattern, RunNumber) ); + + // Set to read in Hall C run database parameters + run->SetRunParamClass("THcRunParameters"); + + // Eventually need to learn to skip over, or properly analyze the pedestal events + run->SetEventRange(1, MaxEvent); // Physics Event number, does not include scaler or control events. + run->SetNscan(1); + run->SetDataRequired(0x7); + run->Print(); + + // Define the analysis parameters + TString ROOTFileName = Form(ROOTFileNamePattern, RunNumber, MaxEvent); + analyzer->SetCountMode(2); // 0 = counter is # of physics triggers + // 1 = counter is # of all decode reads + // 2 = counter is event number + + analyzer->SetEvent(event); + // Set EPICS event type + analyzer->SetEpicsEvtType(180); + // Define crate map + analyzer->SetCrateMapFileName("MAPS/db_cratemap.dat"); + // Define output ROOT file + analyzer->SetOutFile(ROOTFileName.Data()); + // Define DEF-file+ + analyzer->SetOdefFile("DEF-files/COIN/PRODUCTION/coin_production_hElec_pProt.def"); + // Define cuts file + analyzer->SetCutFile("DEF-files/COIN/PRODUCTION/CUTS/coin_production_cuts.def"); // optional + // File to record accounting information for cuts + analyzer->SetSummaryFile(Form("REPORT_OUTPUT/COIN/PRODUCTION/summary_production_%d_%d.report", RunNumber, MaxEvent)); // optional + // Start the actual analysis. + analyzer->Process(run); + // Create report file from template + analyzer->PrintReport("TEMPLATES/COIN/PRODUCTION/coin_production.template", + Form("REPORT_OUTPUT/COIN/PRODUCTION/replay_coin_production_%d_%d.report", RunNumber, MaxEvent)); // optional + +} diff --git a/tests/elastic_test.cxx b/tests/elastic_test.cxx new file mode 100644 index 0000000000000000000000000000000000000000..4c9ad79f09c3cfefec9d399f8fd68d6718ee3551 --- /dev/null +++ b/tests/elastic_test.cxx @@ -0,0 +1,446 @@ +#include "nlohmann/json.hpp" +#include <cmath> +#include <iostream> + +#include "ROOT/RDataFrame.hxx" +#include "ROOT/RVec.hxx" + +#include "Math/Vector3D.h" +#include "Math/Vector4D.h" +#include "Math/VectorUtil.h" +#include "TCanvas.h" +#include "TLatex.h" +#include "TStyle.h" +#include "TSystem.h" +R__LOAD_LIBRARY(libMathMore.so) +R__LOAD_LIBRARY(libGenVector.so) + +R__LOAD_LIBRARY(libfmt.so) +#include "fmt/core.h" + +#include "THStack.h" + +#ifdef __cpp_lib_filesystem +#include <filesystem> +namespace fs = std::filesystem; +#else +#include <experimental/filesystem> +namespace fs = std::experimental::filesystem; +#endif + +using RDFNode = decltype(ROOT::RDataFrame{0}.Filter("")); +using Histo1DProxy = + decltype(ROOT::RDataFrame{0}.Histo1D(ROOT::RDF::TH1DModel{"", "", 128u, 0., 0.}, "")); + +struct RDFInfo { + RDFNode& df; + const std::string title; + RDFInfo(RDFNode& df, std::string_view title) : df{df}, title{title} {} +}; + +constexpr const double M_P = .938272; +constexpr const double M_P2 = M_P * M_P; +constexpr const double M_pion = 0.139; +constexpr const double M_pion2 = M_pion * M_pion; +constexpr const double M_e = .000511; + +// ================================================================================= +// Cuts +// ================================================================================= +std::string goodTrackSHMS = "P.gtr.dp > -10 && P.gtr.dp < 22"; +std::string goodTrackHMS = "H.gtr.dp > -8 && H.gtr.dp < 8"; + +std::string piCutSHMS = "P.cal.etottracknorm<1.0"; +//std::string piCutSHMS = "P.aero.npeSum > 1.0 && P.cal.eprtracknorm < 0.2 && P.cal.etottracknorm<1.0"; + +std::string eCutHMS = "H.cal.etottracknorm > 0.50 && H.cal.etottracknorm < 2. && " + "H.cer.npeSum > 1."; + +std::string epiCut = "P.aero.npeSum > 1.0 && P.cal.eprtracknorm < 0.2 && " + "H.cer.npeSum > 1.0 && H.cal.etottracknorm > 0.6 && " + "H.cal.etottracknorm < 2.0 && P.cal.etottracknorm<1.0"; + +using Pvec3D = ROOT::Math::XYZVector; +using Pvec4D = ROOT::Math::PxPyPzMVector; + +// ================================================================================= +// reconstruction +// ================================================================================= +auto p_pion = [](double px, double py, double pz) { + return Pvec4D{px * 0.996, py * 0.996, pz * 0.996, M_e}; +}; +auto p_electron = [](double px, double py, double pz) { + return Pvec4D{px * 0.994, py * 0.994, pz * 0.994, M_e}; +}; +auto t = [](const double Egamma, Pvec4D& jpsi) { + Pvec4D beam{0, 0, Egamma, 0}; + return (beam - jpsi).M2(); +}; + +bool root_file_exists(std::string rootfile) { + bool found_good_file = false; + if (!gSystem->AccessPathName(rootfile.c_str())) { + TFile file(rootfile.c_str()); + if (file.IsZombie()) { + std::cout << rootfile << " is a zombie.\n"; + std::cout + << " Did your replay finish? Check that the it is done before running this script.\n"; + return false; + // return; + } else { + std::cout << " using : " << rootfile << "\n"; + return true; + } + } + return false; +} + +void elastic_test(int RunNumber = 6012, int nevents = 50000, int prompt = 0, int update = 0, + int default_count_goal = 10000, int redo_timing = 0) { + + // =============================================================================================== + // Initialization + // =============================================================================================== + using nlohmann::json; + json j; + { + std::ifstream json_input_file("db2/run_list_coin.json"); + try { + json_input_file >> j; + } catch (json::parse_error) { + std::cerr << "error: json file, db2/run_list.json, is incomplete or has broken syntax.\n"; + std::quick_exit(-127); + } + } + + auto runnum_str = std::to_string(RunNumber); + if (j.find(runnum_str) == j.end()) { + std::cout << "Run " << RunNumber << " not found in db2/run_list_coin.json\n"; + std::cout << "Check that run number and replay exists. \n"; + std::cout << "If problem persists please contact Sylvester (217-848-0565)\n"; + } + double P0_shms_setting = j[runnum_str]["spectrometers"]["shms_momentum"].get<double>(); + double P0_shms = std::abs(P0_shms_setting); + + bool found_good_file = false; + + std::string rootfile = + fmt::format("full_online/coin_replay_production_{}_{}.root", RunNumber, nevents); + found_good_file = root_file_exists(rootfile.c_str()); + if (!found_good_file) { + rootfile = + fmt::format("ROOTfiles_volatile/coin_replay_production_{}_{}.root", RunNumber, nevents); + found_good_file = root_file_exists(rootfile.c_str()); + } + if (!found_good_file) { + rootfile = fmt::format("ROOTfiles_csv/coin_replay_production_{}_{}.root", RunNumber, nevents); + found_good_file = root_file_exists(rootfile.c_str()); + } + if (!found_good_file) { + rootfile = fmt::format("ROOTfiles/coin_replay_production_{}_{}.root", RunNumber, nevents); + found_good_file = root_file_exists(rootfile.c_str()); + } + if (!found_good_file) { + std::cout << " Error: suitable root file not found\n"; + return; + } + + // =============================================================================================== + // Dataframe + // =============================================================================================== + + ROOT::EnableImplicitMT(24); + + //--------------------------------------------------------------------------- + // Detector tree + ROOT::RDataFrame d("T", rootfile); + + //// SHMS Scaler tree + //ROOT::RDataFrame d_sh("TSP", rootfile); + //// int N_scaler_events = *(d_sh.Count()); + + auto d_coin = d.Filter("fEvtHdr.fEvtType == 4"); + + // Good track cuts + auto dHMSGoodTrack = d_coin.Filter(goodTrackHMS); + auto dSHMSGoodTrack = d_coin.Filter(goodTrackSHMS); + auto dCOINGoodTrack = dHMSGoodTrack.Filter(goodTrackSHMS) + .Define("p_electron", p_electron, {"H.gtr.px", "H.gtr.py", "H.gtr.pz"}) + .Define("p_pion", p_pion, {"P.gtr.px", "P.gtr.py", "P.gtr.pz"}); + // PID cuts + auto dHMSEl = dHMSGoodTrack.Filter(eCutHMS); + auto dSHMSEl = dSHMSGoodTrack.Filter(piCutSHMS); + auto dCOINEl = dCOINGoodTrack.Filter(eCutHMS + " && " + piCutSHMS); + //.Filter( + // [=](double npe, double dp) { + // double p_track = P0_shms * (100.0 + dp) / 100.0; + // // no cerenkov cut needed when momentum is below 2.8 GeV/c + // if (p_track < 2.8) { + // return true; + // } + // return npe > 1.0; + // }, + // {"P.hgcer.npeSum", "P.gtr.dp"}); + + // Timing cuts + // Find the timing peak + // Find the coin peak + double coin_peak_center = 0; + if (redo_timing) { + auto h_coin_time = + dCOINEl.Histo1D({"coin_time", "coin_time", 8000, 0, 1000}, "CTime.ePositronCoinTime_ROC2"); + h_coin_time->DrawClone(); + int coin_peak_bin = h_coin_time->GetMaximumBin(); + coin_peak_center = h_coin_time->GetBinCenter(coin_peak_bin); + std::cout << "COINCIDENCE time peak found at: " << coin_peak_center << std::endl; + } else { + //coin_peak_center = 43.0; // run 7240-7241 + coin_peak_center = 23.0; // run 6012 + std::cout << "COINCIDENCE time peak: using pre-calculated value at: " << coin_peak_center + << std::endl; + ; + } + // timing cut lambdas + // TODO: evaluate timing cut and offset for random background + auto timing_cut = [=](double coin_time) { return std::abs(coin_time - coin_peak_center) < 2.; }; + // anti-timing set to 5x width of regular + auto anti_timing_cut = [=](double coin_time) { + return std::abs(coin_time - coin_peak_center - 28.) < 10.; + }; + + // timing counts + auto dHMSElInTime = dHMSEl.Filter(timing_cut, {"CTime.ePositronCoinTime_ROC2"}); + auto dHMSElRandom = dHMSEl.Filter(anti_timing_cut, {"CTime.ePositronCoinTime_ROC2"}); + auto dSHMSElInTime = dSHMSEl.Filter(timing_cut, {"CTime.ePositronCoinTime_ROC2"}); + auto dSHMSElRandom = dSHMSEl.Filter(anti_timing_cut, {"CTime.ePositronCoinTime_ROC2"}); + + auto dCOINElInTime = dCOINEl.Filter(timing_cut, {"CTime.ePiCoinTime_ROC2"}); + auto dCOINElRandom = dCOINEl.Filter(anti_timing_cut, {"CTime.ePiCoinTime_ROC2"}); + + // Output root file + //auto out_file = + // new TFile(fmt::format("monitoring/{}/good_csv_counter.root", RunNumber).c_str(), "UPDATE"); + //out_file->cd(); + + // ========================================================================================= + // Histograms + // ========================================================================================= + // 2D correlations + auto hTheta2DNoCuts = d_coin.Histo2D( + {"theta2D", "No cuts;#theta_{SHMS};#theta_{HMS};#counts", 50, -.1, .1, 50, -.1, .1}, + "P.gtr.th", "H.gtr.th"); + auto hTheta2DTracking = dCOINGoodTrack.Histo2D( + {"theta2D", "Cuts: tracking;#theta_{SHMS};#theta_{HMS};#counts", 50, -.1, .1, 50, -.1, .1}, + "P.gtr.th", "H.gtr.th"); + auto hTheta2DPID = + dCOINEl.Histo2D({"theta2D", "Cuts: tracking+PID;#theta_{SHMS};#theta_{HMS};#counts", 50, -.1, + .1, 50, -.1, .1}, + "P.gtr.th", "H.gtr.th"); + auto hTheta2DTiming = + dCOINElInTime.Histo2D({"theta2D", "Cuts: tracking+PID;#theta_{SHMS};#theta_{HMS};#counts", 50, + -.1, .1, 50, -.1, .1}, + "P.gtr.th", "H.gtr.th"); + // timing + auto hCoinTimeNoCuts = + d_coin.Histo1D({"coin_time.NoCuts", "No Cuts;coin_time;counts", 8000, 0, 1000}, + "CTime.ePositronCoinTime_ROC2"); + auto hCoinTimeTracking = dCOINGoodTrack.Histo1D( + {"coin_time.Tracking", "Cuts: Tracking;coin_time;counts", 8000, 0, 1000}, + "CTime.ePositronCoinTime_ROC2"); + auto hCoinTimePID = + dCOINEl.Histo1D({"coin_time.PID", "Cuts: Tracking+PID;coin_time;counts", 8000, 0, 1000}, + "CTime.ePositronCoinTime_ROC2"); + auto hCoinTimeTiming = dCOINElInTime.Histo1D( + {"coin_time.Timing", "Cuts: Tracking+PID+Timing;coin_time;counts", 8000, 0, 1000}, + "CTime.ePositronCoinTime_ROC2"); + + auto hRandCoinTimePID = dCOINElRandom.Histo1D( + {"rand_coin_time.PID", "Cuts: Tracking+PID;coin_time;counts", 8000, 0, 1000}, + "CTime.ePositronCoinTime_ROC2"); + + // P.gtr.dp + auto hPdpNoCuts = + d_coin.Histo1D({"P.gtr.dp.NoCuts", "No Cuts;#deltap [%];counts", 200, -30, 40}, "P.gtr.dp"); + auto hPdpTracking = dSHMSGoodTrack.Histo1D( + {"P.gtr.dp.Tracking", "Cuts: Tracking;#deltap [%];counts", 200, -30, 40}, "P.gtr.dp"); + auto hPdpPID = dSHMSEl.Histo1D( + {"P.gtr.dp.PID", "Cuts: Tracking+PID;#deltap [%];counts", 200, -30, 40}, "P.gtr.dp"); + auto hPdpTiming = dSHMSElInTime.Histo1D( + {"P.gtr.dp.Timing", "Cuts: Tracking+PID+Timing;#deltap [%];counts", 200, -30, 40}, + "P.gtr.dp"); + // P.gtr.th + auto hPthNoCuts = d_coin.Histo1D( + {"P.gtr.th.NoCuts", "No Cuts;#theta_{SHMS};counts", 200, -0.1, 0.1}, "P.gtr.th"); + auto hPthTracking = dSHMSGoodTrack.Histo1D( + {"P.gtr.th.Tracking", "Cuts: Tracking;#theta_{SHMS};counts", 200, -0.1, 0.1}, "P.gtr.th"); + auto hPthPID = dSHMSEl.Histo1D( + {"P.gtr.th.PID", "Cuts: Tracking+PID;#theta_{SHMS};counts", 200, -0.1, 0.1}, "P.gtr.th"); + auto hPthTiming = dSHMSElInTime.Histo1D( + {"P.gtr.th.Timing", "Cuts: Tracking+PID+Timing;#theta_{SHMS};counts", 200, -0.1, 0.1}, + "P.gtr.th"); + // P.gtr.ph + auto hPphNoCuts = + d_coin.Histo1D({"P.gtr.ph.NoCuts", "No Cuts;#phi_{SHMS};counts", 200, -0.1, 0.1}, "P.gtr.ph"); + auto hPphTracking = dSHMSGoodTrack.Histo1D( + {"P.gtr.ph.Tracking", "Cuts: Tracking;#phi_{SHMS};counts", 200, -0.1, 0.1}, "P.gtr.ph"); + auto hPphPID = dSHMSEl.Histo1D( + {"P.gtr.ph.PID", "Cuts: Tracking+PID;#phi_{SHMS};counts", 200, -0.1, 0.1}, "P.gtr.ph"); + auto hPphTiming = dSHMSElInTime.Histo1D( + {"P.gtr.ph.Timing", "Cuts: Tracking+PID+Timing;#phi_{SHMS};counts", 200, -0.1, 0.1}, + "P.gtr.ph"); + // P.gtr.y + auto hPyNoCuts = + d_coin.Histo1D({"P.gtr.y.NoCuts", "No Cuts;ytar;counts", 200, -10., 10.}, "P.gtr.y"); + auto hPyTracking = dSHMSGoodTrack.Histo1D( + {"P.gtr.y.Tracking", "Cuts: Tracking;ytar;counts", 200, -10., 10.}, "P.gtr.y"); + auto hPyPID = + dSHMSEl.Histo1D({"P.gtr.y.PID", "Cuts: Tracking+PID;ytar;counts", 200, -10., 10.}, "P.gtr.y"); + auto hPyTiming = dSHMSElInTime.Histo1D( + {"P.gtr.y.Timing", "Cuts: Tracking+PID+Timing;ytar;counts", 200, -10., 10.}, "P.gtr.y"); + // P.cal.etottracknorm + auto hPcalEPNoCuts = + d_coin.Histo1D({"P.cal.etottracknorm.NoCuts", "No Cuts;SHMS E/P;counts", 200, -.5, 1.5}, + "P.cal.etottracknorm"); + auto hPcalEPTracking = dSHMSGoodTrack.Histo1D( + {"P.cal.etottracknorm.Tracking", "Cuts: Tracking;SHMS E/P;counts", 200, -.5, 1.5}, + "P.cal.etottracknorm"); + auto hPcalEPPID = dSHMSEl.Histo1D( + {"P.cal.etottracknorm.PID", "Cuts: Tracking+PID;SHMS E/P;counts", 200, -.5, 1.5}, + "P.cal.etottracknorm"); + auto hPcalEPAll = dCOINElInTime.Histo1D( + {"P.cal.etottracknorm.All", "Cuts: Tracking+PID+Coincidence;SHMS E/P;counts", 200, -.5, 1.5}, + "P.cal.etottracknorm"); + // P.ngcer.npeSum + auto hPcerNpheNoCuts = d_coin.Histo1D( + {"P.ngcer.npeSum.NoCuts", "No Cuts;SHMS NGC #phe;counts", 200, -5, 76}, "P.ngcer.npeSum"); + auto hPcerNpheTracking = dSHMSGoodTrack.Histo1D( + {"P.ngcer.npeSum.Tracking", "Cuts: Tracking;SHMS NGC #phe;counts", 200, -5, 76}, + "P.ngcer.npeSum"); + auto hPcerNphePID = dSHMSEl.Histo1D( + {"P.ngcer.npeSum.PID", "Cuts: Tracking+PID;SHMS NGC #phe;counts", 200, -5, 76}, + "P.ngcer.npeSum"); + auto hPcerNpheAll = dCOINElInTime.Histo1D( + {"P.ngcer.npeSum.All", "Cuts: Tracking+PID+Coincidence;SHMS NGC #phe;counts", 200, -5, 76}, + "P.ngcer.npeSum"); + // P.hgcer.npeSum + auto hPhgcerNpheNoCuts = d_coin.Histo1D( + {"P.hgcer.npeSum.NoCuts", "No Cuts;SHMS HGC #phe;counts", 200, -5, 76}, "P.hgcer.npeSum"); + auto hPhgcerNpheTracking = dSHMSGoodTrack.Histo1D( + {"P.hgcer.npeSum.Tracking", "Cuts: Tracking;SHMS HGC #phe;counts", 200, -5, 76}, + "P.hgcer.npeSum"); + auto hPhgcerNphePID = dSHMSEl.Histo1D( + {"P.hgcer.npeSum.PID", "Cuts: Tracking+PID;SHMS HGC #phe;counts", 200, -5, 76}, + "P.hgcer.npeSum"); + auto hPhgcerNpheAll = dCOINElInTime.Histo1D( + {"P.hgcer.npeSum.All", "Cuts: Tracking+PID+Coincidence;SHMS HGC #phe;counts", 200, -5, 76}, + "P.hgcer.npeSum"); + // H.cal.etottracknorm + auto hHcalEPNoCuts = + d_coin.Histo1D({"H.cal.etottracknorm.NoCuts", "No Cuts;HMS E/P;counts", 200, -.5, 1.5}, + "H.cal.etottracknorm"); + auto hHcalEPTracking = dHMSGoodTrack.Histo1D( + {"H.cal.etottracknorm.Tracking", "Cuts: Tracking;HMS E/P;counts", 200, -.5, 1.5}, + "H.cal.etottracknorm"); + auto hHcalEPPID = dHMSEl.Histo1D( + {"H.cal.etottracknorm.PID", "Cuts: Tracking+PID;HMS E/P;counts", 200, -.5, 1.5}, + "H.cal.etottracknorm"); + auto hHcalEPAll = dCOINElInTime.Histo1D( + {"H.cal.etottracknorm.All", "Cuts: Tracking+PID+Coincidence;HMS E/P;counts", 200, -.5, 1.5}, + "H.cal.etottracknorm"); + // H.cer.npeSum + auto hHcerNpheNoCuts = d_coin.Histo1D( + {"H.cer.npeSum.NoCuts", "No Cuts;HMS Cer #phe;counts", 200, -1, 15}, "H.cer.npeSum"); + auto hHcerNpheTracking = dHMSGoodTrack.Histo1D( + {"H.cer.npeSum.Tracking", "Cuts: Tracking;HMS Cer #phe;counts", 200, -1, 15}, "H.cer.npeSum"); + auto hHcerNphePID = dHMSEl.Histo1D( + {"H.cer.npeSum.PID", "Cuts: Tracking+PID+Coincidence;HMS Cer #phe;counts", 200, -1, 15}, + "H.cer.npeSum"); + auto hHcerNpheAll = dCOINElInTime.Histo1D( + {"H.cer.npeSum.PID", "Cuts: Tracking+PID+Coincidence;HMS Cer #phe;counts", 200, -1, 15}, + "H.cer.npeSum"); + // H.gtr.dp + auto hHdpNoCuts = + d_coin.Histo1D({"H.gtr.dp.NoCuts", "No Cuts;#deltap [%];counts", 200, -30, 40}, "H.gtr.dp"); + auto hHdpTracking = dHMSGoodTrack.Histo1D( + {"H.gtr.dp.Tracking", "Cuts: Tracking;#deltap [%];counts", 200, -30, 40}, "H.gtr.dp"); + auto hHdpPID = dHMSEl.Histo1D( + {"H.gtr.dp.PID", "Cuts: Tracking+PID;#deltap [%];counts", 200, -30, 40}, "H.gtr.dp"); + auto hHdpTiming = dHMSElInTime.Histo1D( + {"H.gtr.dp.Timing", "Cuts: Tracking+PID+Timing;#deltap [%];counts", 200, -30, 40}, + "H.gtr.dp"); + // H.gtr.th + auto hHthNoCuts = d_coin.Histo1D( + {"H.gtr.th.NoCuts", "No Cuts;#theta_{HMS};counts", 200, -0.1, 0.1}, "H.gtr.th"); + auto hHthTracking = dHMSGoodTrack.Histo1D( + {"H.gtr.th.Tracking", "Cuts: Tracking;#theta_{HMS};counts", 200, -0.1, 0.1}, "H.gtr.th"); + auto hHthPID = dHMSEl.Histo1D( + {"H.gtr.th.PID", "Cuts: Tracking+PID;#theta_{HMS};counts", 200, -0.1, 0.1}, "H.gtr.th"); + auto hHthTiming = dHMSElInTime.Histo1D( + {"H.gtr.th.Timing", "Cuts: Tracking+PID+Timing;#theta_{HMS};counts", 200, -0.1, 0.1}, + "H.gtr.th"); + // H.gtr.ph + auto hHphNoCuts = + d_coin.Histo1D({"H.gtr.ph.NoCuts", "No Cuts;#phi_{HMS};counts", 200, -0.1, 0.1}, "H.gtr.ph"); + auto hHphTracking = dHMSGoodTrack.Histo1D( + {"H.gtr.ph.Tracking", "Cuts: Tracking;#phi_{HMS};counts", 200, -0.1, 0.1}, "H.gtr.ph"); + auto hHphPID = dHMSEl.Histo1D( + {"H.gtr.ph.PID", "Cuts: Tracking+PID;#phi_{HMS};counts", 200, -0.1, 0.1}, "H.gtr.ph"); + auto hHphTiming = dHMSElInTime.Histo1D( + {"H.gtr.ph.Timing", "Cuts: Tracking+PID+Timing;#phi_{HMS};counts", 200, -0.1, 0.1}, + "H.gtr.ph"); + // H.gtr.y + auto hHyNoCuts = + d_coin.Histo1D({"H.gtr.y.NoCuts", "No Cuts;ytar;counts", 200, -10., 10.}, "H.gtr.y"); + auto hHyTracking = dHMSGoodTrack.Histo1D( + {"H.gtr.y.Tracking", "Cuts: Tracking;ytar;counts", 200, -10., 10.}, "H.gtr.y"); + auto hHyPID = + dHMSEl.Histo1D({"H.gtr.y.PID", "Cuts: Tracking+PID;ytar;counts", 200, -10., 10.}, "H.gtr.y"); + auto hHyTiming = dHMSElInTime.Histo1D( + {"H.gtr.y.Timing", "Cuts: Tracking+PID+Timing;ytar;counts", 200, -10., 10.}, "H.gtr.y"); + + // scalers + //auto total_charge = d_sh.Max("P.BCM4B.scalerChargeCut"); + //auto shms_el_real_scaler = d_sh.Max("P.pEL_REAL.scaler"); + //auto hms_el_real_scaler = d_sh.Max("P.hEL_REAL.scaler"); + //auto time_1MHz = d_sh.Max("P.1MHz.scalerTime"); + //auto time_1MHz_cut = d_sh.Max("P.1MHz.scalerTimeCut"); + + auto yield_all = d.Count(); + // 5 timing cut widths worth of random backgrounds + auto yield_coin = d_coin.Count(); + auto yield_HMSGoodTrack = dHMSGoodTrack.Count(); + auto yield_SHMSGoodTrack = dSHMSGoodTrack.Count(); + auto yield_COINGoodTrack = dCOINGoodTrack.Count(); + auto yield_HMSEl = dHMSEl.Count(); + auto yield_SHMSEl = dSHMSEl.Count(); + auto yield_COINEl = dCOINEl.Count(); + auto yield_HMSElInTime = dHMSElInTime.Count(); + auto yield_HMSElRandom = dHMSElRandom.Count(); + auto yield_SHMSElInTime = dSHMSElInTime.Count(); + auto yield_SHMSElRandom = dSHMSElRandom.Count(); + auto yield_COINElInTime = dCOINElInTime.Count(); + auto yield_COINElRandom = dCOINElRandom.Count(); + auto yield_coin_raw = dCOINElInTime.Count(); + auto yield_coin_random = dCOINElRandom.Count(); + + + // ------------------------------------- + // End lazy eval + // ------------------------------------- + auto n_coin_good = *yield_coin_raw - *yield_coin_random / 5.; + auto n_HMSElGood = *yield_HMSElInTime - *yield_HMSElRandom / 5; + auto n_SHMSElGood = *yield_SHMSElInTime - *yield_SHMSElRandom / 5; + auto n_COINElGood = *yield_COINElInTime - *yield_COINElRandom / 5; + + hPdpNoCuts->DrawCopy(); + //std::cout << " coin COUNTS : " << *(d_coin.Count()) << "\n"; + //std::cout << " yield_HMSEl : " << *(yield_HMSEl) << "\n"; + std::cout << " yield_COINEl : " << *(yield_COINEl) << "\n"; + //std::cout << " ALL COUNTS : " << *yield_all << "\n"; + //std::cout << " GOOD COUNTS : " << n_COINElGood << "\n"; + // + if( 4 != (*(yield_COINEl)) ){ + std::exit(-1); + } + std::exit(0); +} diff --git a/tests/elastic_test.sh b/tests/elastic_test.sh new file mode 100644 index 0000000000000000000000000000000000000000..5d137e59c5413ab3ab02a67612ca8466182b04f9 --- /dev/null +++ b/tests/elastic_test.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +#echo "This is the elastic testing..." +#echo " " +#echo "There are currently 0 tests to run!" +#which hcana +# +#ls -lrth +#ls -lrth build +# +#git clone git@eicweb.phy.anl.gov:jlab/hallc/exp/CSV/hallc_replay_csv.git +#git clone git@eicweb.phy.anl.gov:jlab/hallc/exp/CSV/online_csv.git +#cd online_csv +#ln -s ../hallc_reaply_csv/PARAM +## and the reset +# +#mkdir raw +#pushd raw +# wget coin.dat +#popd + + +singularity help build/Singularity.hcana.simg + + +singularity exec build/Singularity.hcana.simg hcana tests/elastic_test.cxx diff --git a/tests/elastic_test2.sh b/tests/elastic_test2.sh new file mode 100644 index 0000000000000000000000000000000000000000..36da2058d88749b20c9af12ce265f23befd157c2 --- /dev/null +++ b/tests/elastic_test2.sh @@ -0,0 +1,30 @@ +#!/bin/bash + +echo "This is the elastic testing..." +echo " " +echo "There are currently 0 tests to run!" +which hcana + +ls -lrth +ls -lrth build + +git clone git@eicweb.phy.anl.gov:jlab/hallc/exp/CSV/hallc_replay_csv.git +git clone git@eicweb.phy.anl.gov:jlab/hallc/exp/CSV/online_csv.git + +cd online_csv +ln -s ../hallc_reaply_csv/PARAM +# and the reset + +mkdir raw +pushd raw + wget coin.dat +popd + + +singularity help build/Singularity.hcana.simg + +singularity exec build/Singularity.hcana.simg which hcana + +singularity exec build/Singularity.hcana.simg hcana tests/my_root_script.cxx + +echo " WOOOO" diff --git a/tests/my_root_script.cxx b/tests/my_root_script.cxx new file mode 100644 index 0000000000000000000000000000000000000000..0d3686284d799790b779b7724cdbca81d3a5c129 --- /dev/null +++ b/tests/my_root_script.cxx @@ -0,0 +1,20 @@ +void my_root_script() { + + + + std::cout << "Hello from my_root_script.cxx!\n"; + + std::cout << "This should be run with singularity\n"; + double pi = 3.14; + + auto pi_equals_3 = (3 == pi); + std::cout << " pi_equals_3 = " << pi_equals_3 << "\n"; + + if( pi_equals_3) { + std::cout << "what the hell?\n"; + std::exit( 0 ); + } + /* else */ + + std::exit( -1 ); +} diff --git a/tests/replay_elastic_data.sh b/tests/replay_elastic_data.sh new file mode 100644 index 0000000000000000000000000000000000000000..48b147f737be5ce6b44ed32e39f3505b377dccb8 --- /dev/null +++ b/tests/replay_elastic_data.sh @@ -0,0 +1,38 @@ +#!/bin/bash + +echo "This is the elastic testing..." +echo " " +echo "There are currently 0 tests to run!" +which hcana + +ls -lrth +ls -lrth build +mkdir -p ROOTfiles +git clone https://eicweb.phy.anl.gov/whit/ci_test_data.git +git clone https://eicweb.phy.anl.gov/jlab/hallc/exp/CSV/hallc_replay_csv.git +git clone https://eicweb.phy.anl.gov/jlab/hallc/exp/CSV/online_csv.git + +cd online_csv +mkdir -p logs +ln -s ../hallc_replay_csv/PARAM +ln -s ../hallc_replay_csv/DBASE +ln -s ../hallc_replay_csv/CALIBRATION +ln -s ../hallc_replay_csv/DEF-files +ln -s ../hallc_replay_csv/MAPS +ln -s ../hallc_replay_csv/SCRIPTS +ln -s ../hallc_replay_csv/DATFILES +ln -s ../ci_test_data/raw +ln -s ../ROOTfiles +# and the reset + +ls -lrth +ls -lrth raw/ +ls -lrth ROOTfiles/ +pwd +# run replay script +df -h + +singularity exec ../build/Singularity.hcana.simg hcana -b -q "../tests/elastic_coin_replay.cxx+(6012,50000)" + +echo "hcana calls... the coin replay script and outputs blah.root" +