README.md

Go to the documentation of this file.

# Documentation{#mainpage}
\tableofcontents

CAEN S.p.A.

Via Vetraia, 11 - 55049 - Viareggio (LU) - ITALY
Tel +39 0594 388 398
Fax +39 0584 388 959
[info@caen.it](mailto:info@caen.it)
[www.caen.it](https://www.caen.it)

# Introduction
The **CAEN Utility** library contains platform-independent tools used across several CAEN projects.

# Contents
* CAENAllocator.h Tools to handle resource creation and destruction.
* CAENLinkedList.h Linked List implementation in C.
* CAENExpressionEvaluator.h Tools to compute the numeric result of a string.
* CAENLogger.h Logger implemented in C.
* CAENMap.h Hash table implemented in C.
* CAENMultiplatform.h Generic wrappers to platform-dependent functions.
* CAENThread.h Thread support, inspired to C11 threads.h
* CAENRandom.h Pseudo-random number generator.
* CAENSocket.h Plafform independent support to TCP/IP
* CAENSerDes.h TCP/IP CAEN protocol.
* CAENUtility.h Main header and generic tools.
* CAENXMLParser.h Tools to parse an XML file using libxml.

# Copyright notice
Copyright © 2020-2022 CAEN SpA

The CAEN Utility is free software; you can redistribute it and/or
modify it under the terms of the **GNU Lesser General Public
License** as published by the Free Software Foundation; either
version 3 of the License, or (at your option) any later version.

The CAEN Utility 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
Lesser General Public License for more details.

You have received a copy of the GNU Lesser General Public License along
with the CAEN Utility:
- [GNU General Public Library, version 3](@ref COPYING)
- [GNU Lesser General Public Library, version 3](@ref COPYING.LESSER)

The license applies to the CAEN Utility source as a whole, though
individual source files can have a different license which is required to be
compatible with the GNU Lesser General Public Library, version 3. You may find
more details on the @ref credits section of this file.

# Credits{#credits}
The CAEN Utility is made possible by other third part open source software.

## URL Parse
* Source: https://github.com/Xsoda/url
* License: *BSD 2-Clause "Simplified" License*
* Copyright: *Copyright © 2014, 小苏打*
* Author: *Xsoda*

## Map
* Source: https://github.com/rxi/map
* License: *MIT license*
* Copyright: *Copyright © 2014 rxi*
* Author: *rxi*

## POSIX Directory Browsing API for Windows
* Source: https://github.com/octopusprime314/ReBoot/
* License:     
> *Permission to use, copy, modify, and distribute this software and its
> documentation for any purpose is hereby granted without fee, provided
> that this copyright and permissions notice appear in all copies and
> derivatives.
> This software is supplied "as is" without express or implied warranty.
> But that said, if there are any problems please get in touch.*
* Copyright: *Copyright © 1997, 2003, Kevlin Henney*
* Author: *Kevlin Henney*

## XGetopt 1.2
* Source: [XGetopt](https://www.codeproject.com/Articles/1940/XGetopt-A-Unix-compatible-getopt-for-MFC-and-Win)
* License: *Public domain*
* Author: *Hans Dietrich*