Utility.h 8.73 KB
Newer Older
hrchilds's avatar
hrchilds committed
1 2
/*****************************************************************************
*
3
* Copyright (c) 2000 - 2012, Lawrence Livermore National Security, LLC
hrchilds's avatar
hrchilds committed
4
* Produced at the Lawrence Livermore National Laboratory
5
* LLNL-CODE-442911
hrchilds's avatar
hrchilds committed
6 7
* All rights reserved.
*
8
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
hrchilds's avatar
hrchilds committed
9 10 11 12 13 14 15 16 17 18
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution  and  use  in  source  and  binary  forms,  with  or  without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of  source code must  retain the above  copyright notice,
*    this list of conditions and the disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
19 20 21
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL nor the names of  its contributors may
*    be used to endorse or promote products derived from this software without
hrchilds's avatar
hrchilds committed
22 23 24 25 26
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
27 28 29
* ARE  DISCLAIMED. IN  NO EVENT  SHALL LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  OR  CONTRIBUTORS BE  LIABLE  FOR  ANY
* DIRECT,  INDIRECT,   INCIDENTAL,   SPECIAL,   EXEMPLARY,  OR   CONSEQUENTIAL
hrchilds's avatar
hrchilds committed
30 31 32 33 34 35 36 37 38
* 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.
*
*****************************************************************************/

hrchilds's avatar
hrchilds committed
39 40 41 42 43 44 45
// ************************************************************************* //
//                                Utility.h                                  //
// ************************************************************************* //

#ifndef UTILITY_H
#define UTILITY_H
#include <utility_exports.h>
46
#include <visitstream.h>
hrchilds's avatar
hrchilds committed
47
#include <visit-config.h>
48
#include <vectortypes.h>
49
#include <map>
hrchilds's avatar
hrchilds committed
50

51 52
#include <limits.h>
#include <float.h>
hrchilds's avatar
hrchilds committed
53

hrchilds's avatar
hrchilds committed
54 55 56 57 58 59
//
// Function Prototypes
//
char UTILITY_API *CreateMessageStrings(char **, int *, int);
int  UTILITY_API  LongestCommonPrefixLength(const char * const *, int);
int  UTILITY_API  LongestCommonSuffixLength(const char * const *, int);
hrchilds's avatar
hrchilds committed
60

61
// LINUX ONLY
62
void UTILITY_API  GetMemorySize(unsigned long &, unsigned long &);
63
void UTILITY_API  PrintCallStack(ostream &out, const char *file, int line);
64

hrchilds's avatar
hrchilds committed
65 66 67
void UTILITY_API  WaitUntilFile(const char *);
bool UTILITY_API  WildcardStringMatch(const char *p, const char *s);
bool UTILITY_API  WildcardStringMatch(const std::string &p, const std::string &s);
hrchilds's avatar
hrchilds committed
68
bool UTILITY_API  NumericStringCompare(const std::string &str1, const std::string &str2);
hrchilds's avatar
hrchilds committed
69

hrchilds's avatar
hrchilds committed
70
std::vector<std::string> UTILITY_API SplitValues(const std::string &buff,
hrchilds's avatar
hrchilds committed
71 72
                                                 char delim);

73 74 75 76
bool        UTILITY_API VisItInitExtentsToLimits(double *exts, int n);
bool        UTILITY_API VisItInitExtentsToLimits(float *exts, int n);
bool        UTILITY_API VisItInitExtentsToLimits(int *exts, int n);

whitlocb's avatar
whitlocb committed
77
// NOTE: Put these in their own header.
78 79 80 81 82 83 84
void UTILITY_API PutOnSameXIntervals(int on1, const float *ox1, 
        const float *oy1, int on2, const float *ox2, const float *oy2,
        floatVector &usedX, floatVector &newCurve1Vals,
        floatVector &newCurve2Vals);
void UTILITY_API AverageYValsForDuplicateX(int n, const float *x, 
        const float *y, floatVector &X, floatVector &Y);

85
bool UTILITY_API CheckHostValidity(const std::string &host);
86 87 88
bool UTILITY_API ConvertArgsToTunneledValues(const std::map<int,int>&,
                                             std::vector<std::string>&);
bool UTILITY_API GetSSHClient(std::string &sshClient);
89

hrchilds's avatar
hrchilds committed
90
inline char *C_strdup(char const * const);
91
inline char *C_strndup(char const * const, size_t);
hrchilds's avatar
hrchilds committed
92
inline char *CXX_strdup(char const * const);
hrchilds's avatar
hrchilds committed
93
inline char *CXX_strndup(char const * const, size_t);
hrchilds's avatar
hrchilds committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
inline void  InlineCopy(char *&, const char * const &, const int &);
inline void  InlineExtract(char * const &, const char *&, const int &);

//
// Includes for inlined functions.
//

#include <stdio.h>
#include <stdlib.h>
#include <string.h>


// ****************************************************************************
//  Method: C_strdup
//
//  Purpose:
//      Acts like a strdup, which is not used because it is apparently unsafe.
//      Makes a copy of the string using calloc.
//
//  Returns:    A copy of the argument string.
//
//  Programmer: Hank Childs
//  Creation:   January 25, 2000
//
// ****************************************************************************

inline char *
C_strdup(char const * const c)
{
    void *v = calloc(strlen(c)+1, sizeof(char));
    char *p = static_cast< char * >(v);
    strcpy(p, c);
    return p;
}

129 130 131 132 133 134 135 136 137
inline char *
C_strndup(char const * const c, size_t n)
{
    size_t len = (strlen(c) < n) ? strlen(c) : n;
    char *p = (char *) malloc(len+1);
    memcpy(p, c, len);
    p[len] = '\0';
    return p;
}
hrchilds's avatar
hrchilds committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152

// ****************************************************************************
//  Method: CXX_strdup
//
//  Purpose:
//      Acts like a strdup, which is not used because it is apparently unsafe.
//      Makes a copy of the string using new.
//
//  Returns:    A copy of the argument string.
//
//  Programmer: Hank Childs
//  Creation:   January 25, 2000
//
// ****************************************************************************

hrchilds's avatar
hrchilds committed
153
inline char *
hrchilds's avatar
hrchilds committed
154 155 156 157 158 159 160 161
CXX_strdup(char const * const c)
{
    char *p = new char[strlen(c)+1];
    strcpy(p, c);
    return p;
}


hrchilds's avatar
hrchilds committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
// ****************************************************************************
//  Method: CXX_strndup
//
//  Purpose:
//      Acts like a strndup, which is not used because it is apparently unsafe.
//      Makes a copy of the string using new.
//
//  Returns:    A copy of the argument string.
//
//  Programmer: Eric Brugger
//  Creation:   December 11, 2006
//
// ****************************************************************************

inline char *
CXX_strndup(char const * const c, size_t n)
{
179
    size_t len = (strlen(c) < n) ? strlen(c) : n;
hrchilds's avatar
hrchilds committed
180 181 182 183 184 185 186
    char *p = new char[len+1];
    memcpy(p, c, len);
    p[len] = '\0';
    return p;
}


hrchilds's avatar
hrchilds committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
// ****************************************************************************
//  Function: InlineCopy
//
//  Purpose:
//      Copies a character array to another character array and offsets the
//      target list by the amount copied.
//
//  Programmer: Hank Childs
//  Creation:   January 24, 2001
//
// ****************************************************************************

inline void 
InlineCopy(char *&target, const char * const &src, const int &amount)
{
    for (int i = 0 ; i < amount ; i++)
    {
        target[i] = src[i];
    }
    target += amount;
}


// ****************************************************************************
//  Function: InlineExtract
//
//  Purpose:
//      Copies a character array to another character array and offsets the
//      source list by the amount copied.
//
//  Programmer: Hank Childs
//  Creation:   January 24, 2001
//
// ****************************************************************************

inline void
InlineExtract(char * const &target, const char *&src, const int &amount)
{
    for (int i = 0 ; i < amount ; i++)
    {
        target[i] = src[i];
    }
    src += amount;
}

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
// ****************************************************************************
//  Function: VisItInitExtentsToLimits
//
//  Purpose: Initialize an extents array to numerical limits of platform
//
//  Programmer: Mark C. Miller 
//  Creation:   November 15, 2007 
//
// ****************************************************************************

inline bool 
VisItInitExtentsToLimits(double *exts, int n)
{
    if (!(n == 2 || n == 4 || n == 6))
        return false;

    for (int i = 0; i < n; i++)
        exts[i] = n % 2 ? -DBL_MAX : DBL_MAX;

    return true;
}

inline bool 
VisItInitExtentsToLimits(float *exts, int n)
{
    if (!(n == 2 || n == 4 || n == 6))
        return false;

    for (int i = 0; i < n; i++)
        exts[i] = n % 2 ? -FLT_MAX : FLT_MAX;

    return true;
}

inline bool 
VisItInitExtentsToLimits(int *exts, int n)
{
    if (!(n == 2 || n == 4 || n == 6))
        return false;
hrchilds's avatar
hrchilds committed
271

272 273 274 275 276
    for (int i = 0; i < n; i++)
        exts[i] = n % 2 ? -INT_MAX : INT_MAX;

    return true;
}
hrchilds's avatar
hrchilds committed
277 278 279
#endif