GCUtilities.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2005 by Basler Vision Technologies
//  Author:  Fritz Dierks
//
//  License: This file is published under the license of the EMVA GenICam  Standard Group.
//  A text file describing the legal terms is included in  your installation as 'GenICam_license.pdf'.
//  If for some reason you are missing  this file please contact the EMVA or visit the website
//  (http://www.genicam.org) for a full copy.
//
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD GROUP
//  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
//  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)
//  ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//  
//-----------------------------------------------------------------------------
#ifndef GENAPI_GENAPIUTILITIES_DEF_H_
#define GENAPI_GENAPIUTILITIES_DEF_H_

#if defined (_WIN32)
# include <windows.h>
#endif

#include <GenICamVersion.h>

#include <Base/GCTypes.h>
#include <Base/GCString.h>
#include <Base/GCStringVector.h>
#include <Base/GCException.h>
#include <Base/GCLinkage.h>

#if defined(UNDER_RTSS)
#include <Base/GCRTSSUtilities.h>
#endif // defined(UNDER_RTSS)

#if defined(UNDER_RTSS)
#define USE_TEMP_CACHE_FILE 0
#else
#define USE_TEMP_CACHE_FILE 1
#endif // defined(UNDER_RTSS)

#if defined(UNDER_RTSS)
#define USE_TEMP_CACHE_FILE 0
#else
#define USE_TEMP_CACHE_FILE 1
#endif // defined(UNDER_RTSS)

#if defined (_MSC_VER)
#   if defined (_WIN64)
#       define PLATFORM_NAME "Win64_x64"
#   else
#       define PLATFORM_NAME "Win32_i86"
#   endif
#elif defined (__GNUC__)
#   define GENICAM_GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
#   if defined (__linux__)
#     if defined(__x86_64) || defined(__x86_64__) || defined(__amd64)
#       define PLATFORM_NAME "Linux64_x64"
#     elif defined(__i386) || defined(__i386__)
#       define PLATFORM_NAME "Linux32_i86"
#     elif defined(__arm__) || defined(__TARGET_ARCH_ARM)
#       define PLATFORM_NAME "Linux32_ARMhf"
#     elif defined(__AARCH64EL__) || defined(__AARCH64_CMODEL_SMALL__)
#       define PLATFORM_NAME "Linux64_ARM"
#     endif
#   elif defined (__APPLE__)
#     if defined (__LP64__)
#       define PLATFORM_NAME "Maci64_x64"
#     else
#       error Unsupported Platform
#     endif
#   else
#       error Unknown Platform
#   endif
#else
#   error Unknown Platform
#endif

#ifndef GC_COUNTOF
#   define GC_COUNTOF(arr) (sizeof (arr) / sizeof (arr)[0] )
#endif

namespace GENICAM_NAMESPACE
{
    template<typename Td, typename Ts>
    inline Td INTEGRAL_CAST2( Ts s )
    {
        const Td d = static_cast<Td>( s );
        if ( static_cast<Ts>( d ) != s ){
            throw RUNTIME_EXCEPTION("INTEGRAL_CAST failed");
        }
        return d;
    }

    template<typename T>
    inline T INTEGRAL_CAST( int64_t ll )
    {
        return INTEGRAL_CAST2<T, int64_t>( ll );
    }

    GCBASE_API bool GetCacheFileDirectory(gcstring &CacheFileDirectory);

    GCBASE_API bool HasValidLength(const gcstring &FileName);

    GCBASE_API bool HasValidExtension(const gcstring &FileName);

    // Returns the cache file names in the given cache directory
    GCBASE_API void GetCandidateCacheFilePaths(gcstring_vector &CacheFileNames, const gcstring &CacheFileDirectory);  //

    // Returns the message that corresponds to the last error
    GCBASE_API void GetLastErrorMessage(gcstring &Message);

    GCBASE_API bool DoesEnvironmentVariableExist( const gcstring &VariableName );

    GCBASE_API gcstring GetValueOfEnvironmentVariable( const gcstring &VariableName );
    
    GCBASE_API bool GetValueOfEnvironmentVariable(const gcstring &VariableName, gcstring &VariableContent );

#if defined(UNDER_RTSS)
    GCBASE_API bool DoesFileExist( const gcstring &FilePath );
#endif // defined(UNDER_RTSS)

    GCBASE_API gcstring UrlEncode(const GENICAM_NAMESPACE::gcstring& Input);

    GCBASE_API GENICAM_NAMESPACE::gcstring UrlDecode(const GENICAM_NAMESPACE::gcstring& Input);

    GCBASE_API void ReplaceEnvironmentVariables(gcstring &Buffer, bool ReplaceBlankBy20 = false);



    GCBASE_API gcstring GetGenICamCacheFolder(void);


    GCBASE_API gcstring GetGenICamLogConfig(void);


    GCBASE_API gcstring GetGenICamCLProtocolFolder(void);

    GCBASE_API void SetGenICamCacheFolder(const gcstring& path);

    GCBASE_API void SetGenICamLogConfig(const gcstring& path);

    GCBASE_API void SetGenICamCLProtocolFolder(const gcstring& path);

    GCBASE_API void Tokenize(
        const gcstring& str,                    
        gcstring_vector& tokens,          
        const gcstring& delimiters = " "  
        );

    GCBASE_API void GetFiles(
        const gcstring &FileTemplate,           
        gcstring_vector &FileNames,             
        const bool DirectoriesOnly = false );   

    GCBASE_API gcstring GetModulePathFromFunction(void *pFunction);
}

#define GENICAM_UNUSED(unused_var)    ((void)(unused_var))

#if !defined(GENICAM_DEPRECATED)
#   if defined(__GNUC__) && (((__GNUC__ * 100) + __GNUC_MINOR__ ) >= 301) // is at least GCC 3.1 compiler?
#       define GENICAM_DEPRECATED(FUNCTION) FUNCTION __attribute__ ((deprecated))
#   elif defined(_MSC_VER) && (_MSC_VER >= 1300) // is at least VC 2003 compiler?
#       define GENICAM_DEPRECATED(FUNCTION) __declspec(deprecated) FUNCTION
#   else
#       define GENICAM_DEPRECATED(FUNCTION) FUNCTION
#   endif // compiler check
#endif // #if !defined(GENICAM_DEPRECATED)


// 
//    Useful to create pragma message output recognized by VisualStudio
//
//    Usage:
//       #pragma message ( __ERR__ "Invalid DLL ABI" )
//
// Message formatter
#define _TO_STRING( __stN ) #__stN
#define EXPAND_TO_STRINGISE( __stN ) _TO_STRING( __stN )
#define __LINE_STR__ EXPAND_TO_STRINGISE(__LINE__)
#define __LOCATION__ __FILE__ "(" __LINE_STR__ ")"
#define __OUTPUT_FORMATER__(_type) __LOCATION__ " : " _type " : "

// Message types
#define __WARN__ __OUTPUT_FORMATER__("WARNING")
#define __ERR__ __OUTPUT_FORMATER__("ERROR")
#define __TODO__ __OUTPUT_FORMATER__("TBD")

#endif // GENAPI_GENAPIUTILITIES_DEF_H_