file_attribute.cpp

Go to the documentation of this file.

/** @file
 *  @author Bram de Greve (bramz@users.sourceforge.net)
 *  @author Tom De Muer (tomdemuer@users.sourceforge.net)
 *
 *  *** BEGIN LICENSE INFORMATION ***
 *  
 *  The contents of this file are subject to the Common Public Attribution License 
 *  Version 1.0 (the "License"); you may not use this file except in compliance with 
 *  the License. You may obtain a copy of the License at 
 *  http://lass.sourceforge.net/cpal-license. The License is based on the 
 *  Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover 
 *  use of software over a computer network and provide for limited attribution for 
 *  the Original Developer. In addition, Exhibit A has been modified to be consistent 
 *  with Exhibit B.
 *  
 *  Software distributed under the License is distributed on an "AS IS" basis, WITHOUT 
 *  WARRANTY OF ANY KIND, either express or implied. See the License for the specific 
 *  language governing rights and limitations under the License.
 *  
 *  The Original Code is LASS - Library of Assembled Shared Sources.
 *  
 *  The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
 *  The Original Developer is the Initial Developer.
 *  
 *  All portions of the code written by the Initial Developer are:
 *  Copyright (C) 2004-2007 the Initial Developer.
 *  All Rights Reserved.
 *  
 *  Contributor(s):
 *
 *  Alternatively, the contents of this file may be used under the terms of the 
 *  GNU General Public License Version 2 or later (the GPL), in which case the 
 *  provisions of GPL are applicable instead of those above.  If you wish to allow use
 *  of your version of this file only under the terms of the GPL and not to allow 
 *  others to use your version of this file under the CPAL, indicate your decision by 
 *  deleting the provisions above and replace them with the notice and other 
 *  provisions required by the GPL License. If you do not delete the provisions above,
 *  a recipient may use your version of this file under either the CPAL or the GPL.
 *  
 *  *** END LICENSE INFORMATION ***
 */

#include "io_common.h"
#include "file_attribute.h"
#include "../stde/extended_string.h"

#include <stdio.h>

#if LASS_COMPILER_TYPE == LASS_COMPILER_TYPE_MSVC
#   pragma warning(disable: 4996) // 'fopen': This function or variable may be unsafe
#endif

namespace lass
{
namespace io
{

// --- public --------------------------------------------------------------------------------------



// --- protected -----------------------------------------------------------------------------------



// --- private -------------------------------------------------------------------------------------



// --- free ----------------------------------------------------------------------------------------

/** @ingroup FileAttribute
 *  return true if file exists
 */
bool fileDoesExist(const std::string& iFileName)
{
    FILE* file = fopen(iFileName.c_str(), "r");
    if (file == 0)
    {
        return false;
    }
    fclose(file);
    return true;
}



/** @ingroup FileAttribute
 *  return the part of the file name behind the last dot.
 *  return an empty string if there's no dot.
 *  e.g. @e foo returns an empty string, @e foo.bar returns @e bar,
 *  @e foo.bar.fun returns @e fun.
 */
std::string fileExtension(const std::string& iFileName)
{
    std::string::size_type lastDot = iFileName.rfind(extensionSeperator);
    return lastDot!= std::string::npos ? iFileName.substr(lastDot + 1) : "";
}



/** @ingroup FileAttribute
 *  return the part of the file name before the last dot.
 *  return an original string if there's no dot.
 *  e.g. @e foo returns @e foo, @e foo.bar returns @e foo,
 *  @e foo.bar.fun returns @e foo.bar .
 */
std::string fileWithoutExtension(const std::string& iFileName)
{
    return iFileName.substr(0, iFileName.rfind(extensionSeperator));
}



/** @ingroup FileAttribute
 *  return the part of the file name before the last (back)slash.
 *  return an empty string if there's no (back)slash.
 *  e.g. @e foo returns an empty string, @e foo/bar returns @e foo,
 *  @e foo/bar/fun returns @e foo/bar.
 */
std::string filePath(const std::string& iFileName)
{
    const char seperators[] = { pathSeperator, pathAlternativeSeperator, '\0' }; 
    std::string::size_type lastSlash = iFileName.find_last_of(seperators);
    return lastSlash != std::string::npos ? iFileName.substr(0, lastSlash) : "";
}



/** @ingroup FileAttribute
 *  return the part of the file name behind the last (back)slash.
 *  return the original string if there's no (back)slash.
 *  e.g. @e foo returns @e foo, @e foo/bar returns @e bar,
 *  @e foo/bar/fun returns @e fun .
 */
std::string fileWithoutPath(const std::string& iFileName)
{
    const char seperators[] = { pathSeperator, pathAlternativeSeperator, '\0' }; 
    std::string::size_type lastSlash = iFileName.find_last_of(seperators);
    return lastSlash != std::string::npos ? iFileName.substr(lastSlash + 1) : iFileName;
}



/** @ingroup FileAttribute
 */
std::string fileJoinExtension(const std::string& iFilename, const std::string& iExtension)
{
    const char seperator [] = { extensionSeperator, '\0' };
    if (stde::begins_with(iExtension, std::string(seperator)))
    {
        return iFilename + iExtension;
    }
    return iFilename + seperator + iExtension;
}



/** @ingroup FileAttribute
 */
std::string fileJoinPath(const std::string& iPath, const std::string& iFilename)
{
    const char seperator [] = { pathSeperator, '\0' };
    if (stde::ends_with(iPath, std::string(seperator)))
    {
        return iPath + iFilename;
    }
    const char alternativeSeperator [] = { pathAlternativeSeperator, '\0' };
    if (pathAlternativeSeperator && stde::ends_with(iPath, std::string(alternativeSeperator)))
    {
        return iPath + iFilename;
    }
    return iPath + seperator + iFilename;
}

}

}

// EOF