utilities.h

Go to the documentation of this file.

/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000-2010, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

    See STIR/LICENSE.txt for details
*/
#ifndef __stir_UTILITIES_H__
#define __stir_UTILITIES_H__

#include "stir/common.h"
#include <stdio.h>
#include <iostream>
#include <string>

START_NAMESPACE_STIR

/******************************************************/
template <class NUMBER>
inline NUMBER ask_num(const std::string& prompt, NUMBER minimum_value, NUMBER maximum_value, NUMBER default_value);

std::string ask_string(const std::string& prompt, const std::string& default_value = "");

bool ask(const std::string& prompt, bool default_value);

/***** filename functions ****/

char* ask_filename_with_extension(char* file_in_directory_name, const std::string& prompt, const std::string& default_extension);

std::string ask_filename_with_extension(const std::string& prompt, const std::string& default_extension);

// Implementation note: gcc 2.8.1 seems to have problems with default
// values when templates are around, so I overload the function
template <class FSTREAM>
void ask_filename_and_open(
    FSTREAM& s, const std::string& prompt, const std::string& default_extension, std::ios::openmode mode, bool abort_if_failed);

template <class FSTREAM>
void inline ask_filename_and_open(FSTREAM& s,
                                  const std::string& prompt,
                                  const std::string& default_extension,
                                  std::ios::openmode mode)
{
  ask_filename_and_open(s, prompt, default_extension, mode, true);
}


/******************************************************/
void* read_stream_in_memory(std::istream& input, std::streamsize& file_size);

std::streamsize find_remaining_size(std::istream& input);


template <class IFSTREAM>
inline IFSTREAM& open_read_binary(IFSTREAM& s, const std::string& name);

FILE*& open_read_binary(FILE*& fptr, const std::string& name);


template <class OFSTREAM>
inline OFSTREAM& open_write_binary(OFSTREAM& s, const std::string& name);

FILE*& open_write_binary(FILE*& fptr, const std::string& name);


template <class FSTREAM>
inline void close_file(FSTREAM& s);


void close_file(FILE*& fptr);


const int max_filename_length = 1000;

/******************************************************/


extern const char* find_filename(const char* const filename_with_directory);


std::string::size_type find_pos_of_filename(const std::string& filename_with_directory);


std::string get_filename(const std::string& filename_with_directory);

char* get_directory_name(char* directory_name, const char* const filename_with_directory);


std::string get_directory_name(const std::string& filename_with_directory);

extern bool is_absolute_pathname(const std::string& filename_with_directory);

extern bool is_absolute_pathname(const char* const filename_with_directory);

extern char* prepend_directory_name(char* filename_with_directory, const char* const directory_name);


std::string::size_type find_pos_of_extension(const std::string& file_in_directory_name);
#if 0
// terribly dangerous for memory overrun.

extern char *
add_extension(char * file_in_directory_name, 
              const char * const extension);
#endif

std::string& add_extension(std::string& file_in_directory_name, const std::string& extension);

#if 0
// disabled because possible memory overrun

extern char *
replace_extension(char *file_in_directory_name, 
                  const char * const extension);
#endif

std::string& replace_extension(std::string& file_in_directory_name, const std::string& extension);


/**********************************************************************
 C-string manipulation function
***********************************************************************/
#ifndef _MSC_VER


inline char* strupr(char* const str);
#else
#  define strupr _strupr
#endif

END_NAMESPACE_STIR

#include "stir/utilities.inl"

#endif // __UTILITIES_H__