src/gromacs/utility/dir_separator.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \libinternal \file
  38  * \brief
  39  * Provides OS-specific directory-name separator
  40  *
  41  * \inlibraryapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_DIR_SEPARATOR_H
  45 #define GMX_UTILITY_DIR_SEPARATOR_H
  46
  47 #include "config.h"
  48
  49 /*! \def DIR_SEPARATOR
  50  * \brief
  51  * Directory separator on this OS.
  52  *
  53  * Native Windows uses backslash path separators (but accepts also slashes).
  54  * Cygwin and most other systems use slash.
  55  *
  56  * \todo Get rid of this (Redmine #950). It is not necessary for
  57  * constructing paths on the systems that it currently supports, and
  58  * is not reliable in parsing input paths either, since Windows needs
  59  * to accept both instead of only DIR_SEPARATOR. At the very least, we
  60  * should refactor the clients of this header so that they operate
  61  * upon path objects rather than raw path strings.
  62  */
  63 #if GMX_NATIVE_WINDOWS
  64 #define DIR_SEPARATOR '\\'
  65 #else
  66 #define DIR_SEPARATOR '/'
  67 #endif
  68
  69 #endif