You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
k3b/libk3b/core/k3bglobals.h

258 lines
7.2 KiB

/*
*
* $Id: k3bglobals.h 630384 2007-02-05 09:33:17Z mlaurent $
* Copyright (C) 2003 Sebastian Trueg <trueg@k3b.org>
*
* This file is part of the K3b project.
* Copyright (C) 1998-2007 Sebastian Trueg <trueg@k3b.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* See the file "COPYING" for the exact licensing terms.
*/
#ifndef K3BGLOBALS_H
#define K3BGLOBALS_H
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <tqstring.h>
#include <tqfile.h>
#include <tdeio/global.h>
#include <kurl.h>
#include <k3bdevicetypes.h>
#include "k3b_export.h"
class TDEConfig;
class K3bVersion;
class K3bExternalBin;
#include <sys/stat.h>
#ifdef HAVE_STAT64
#define k3b_struct_stat struct stat64
#define k3b_stat ::stat64
#define k3b_lstat ::lstat64
#else
#define k3b_struct_stat struct stat
#define k3b_stat ::stat
#define k3b_lstat ::lstat
#endif
namespace K3bDevice {
class Device;
}
namespace K3b
{
enum WritingApp {
DEFAULT = 1,
CDRECORD = 2,
CDRDAO = 4,
DVDRECORD = 8,
GROWISOFS = 16,
DVD_RW_FORMAT = 32
};
LIBK3B_EXPORT int writingAppFromString( const TQString& );
/**
* DATA_MODE_AUTO - let K3b determine the best mode
* MODE1 - refers to the default Yellow book mode1
* MODE2 - refers to CDROM XA mode2 form1
*/
enum DataMode {
DATA_MODE_AUTO,
MODE1,
MODE2
};
/**
* The sector size denotes the number of bytes K3b provides per sector.
* This is based on the sizes cdrecord's -data, -xa, and -xamix parameters
* demand.
*/
enum SectorSize {
SECTORSIZE_AUDIO = 2352,
SECTORSIZE_DATA_2048 = 2048,
SECTORSIZE_DATA_2048_SUBHEADER = 2056,
SECTORSIZE_DATA_2324 = 2324,
SECTORSIZE_DATA_2324_SUBHEADER = 2332,
SECTORSIZE_RAW = 2448
};
/**
* AUTO - let K3b determine the best mode
* TAO - Track at once
* DAO - Disk at once (or session at once)
* RAW - Raw mode
*
* may be or'ed together (except for WRITING_MODE_AUTO of course)
*/
enum WritingMode {
WRITING_MODE_AUTO = 0,
TAO = K3bDevice::WRITINGMODE_TAO,
DAO = K3bDevice::WRITINGMODE_SAO,
RAW = K3bDevice::WRITINGMODE_RAW,
WRITING_MODE_INCR_SEQ = K3bDevice::WRITINGMODE_INCR_SEQ, // Incremental Sequential
WRITING_MODE_RES_OVWR = K3bDevice::WRITINGMODE_RES_OVWR // Restricted Overwrite
};
LIBK3B_EXPORT TQString writingModeString( int );
LIBK3B_EXPORT TQString framesToString( int h, bool showFrames = true );
/*LIBK3B_EXPORT TQString sizeToTime( long size );*/
LIBK3B_EXPORT TQ_INT16 swapByteOrder( const TQ_INT16& i );
LIBK3B_EXPORT TQ_INT32 swapByteOrder( const TQ_INT32& i );
LIBK3B_EXPORT TQ_INT64 swapByteOrder( const TQ_INT64& i );
int round( double );
/**
* This checks the free space on the filesystem path is in.
* We use this since we encountered problems with the KDE version.
* @returns true on success.
*/
LIBK3B_EXPORT bool kbFreeOnFs( const TQString& path, unsigned long& size, unsigned long& avail );
/**
* Cut a filename preserving the extension
*/
LIBK3B_EXPORT TQString cutFilename( const TQString& name, unsigned int len );
LIBK3B_EXPORT TQString removeFilenameExtension( const TQString& name );
/**
* Append a number to a filename preserving the extension.
* The resulting name's length will not exceed @p maxlen
*/
LIBK3B_EXPORT TQString appendNumberToFilename( const TQString& name, int num, unsigned int maxlen );
LIBK3B_EXPORT TQString findUniqueFilePrefix( const TQString& _prefix = TQString(), const TQString& path = TQString() );
/**
* Find a unique filename in directory d (if d is empty the method uses the defaultTempPath)
*/
LIBK3B_EXPORT TQString findTempFile( const TQString& ending = TQString(), const TQString& d = TQString() );
/**
* Wrapper around TDEStandardDirs::findExe which searches the PATH and some additional
* directories to find system tools which are normally only in root's PATH.
*/
LIBK3B_EXPORT TQString findExe( const TQString& name );
/**
* get the default K3b temp path to store image files
*/
LIBK3B_EXPORT TQString defaultTempPath();
/**
* makes sure a path ends with a "/"
*/
LIBK3B_EXPORT TQString prepareDir( const TQString& dir );
/**
* returns the parent dir of a path.
* CAUTION: this does only work well with absolut paths.
*
* Example: /usr/share/doc -> /usr/share/
*/
TQString parentDir( const TQString& path );
/**
* For now this just replaces multiple occurrences of / with a single /
*/
LIBK3B_EXPORT TQString fixupPath( const TQString& );
/**
* resolves a symlinks completely. Meaning it also handles links to links to links...
*/
LIBK3B_EXPORT TQString resolveLink( const TQString& );
LIBK3B_EXPORT K3bVersion kernelVersion();
/**
* Kernel version stripped of all suffixes
*/
LIBK3B_EXPORT K3bVersion simpleKernelVersion();
TQString systemName();
LIBK3B_EXPORT TDEIO::filesize_t filesize( const KURL& );
/**
* Calculate the total size of an image file. This also includes
* images splitted by a K3bFileSplitter.
*
* \returns the total size of the image file at url
*/
LIBK3B_EXPORT TDEIO::filesize_t imageFilesize( const KURL& url );
/**
* true if the kernel supports ATAPI devices without SCSI emulation.
* use in combination with the K3bExternalProgram feature "plain-atapi"
*/
LIBK3B_EXPORT bool plainAtapiSupport();
/**
* true if the kernel supports ATAPI devices without SCSI emulation
* via the ATAPI: pseudo stuff
* use in combination with the K3bExternalProgram feature "hacked-atapi"
*/
LIBK3B_EXPORT bool hackedAtapiSupport();
/**
* Used to create a parameter for cdrecord, cdrdao or readcd.
* Takes care of SCSI and ATAPI.
*/
TQString externalBinDeviceParameter( K3bDevice::Device* dev, const K3bExternalBin* );
/**
* Convert an url pointing to a local device to a K3bDevice.
* Supports media:// and system::// urls.
*/
LIBK3B_EXPORT K3bDevice::Device* urlToDevice( const KURL& deviceUrl );
/**
* Tries to convert urls from local protocols != "file" to file (for now supports media:/)
*/
LIBK3B_EXPORT KURL convertToLocalUrl( const KURL& url );
LIBK3B_EXPORT KURL::List convertToLocalUrls( const KURL::List& l );
LIBK3B_EXPORT TQ_INT16 fromLe16( char* );
LIBK3B_EXPORT TQ_INT32 fromLe32( char* );
LIBK3B_EXPORT TQ_INT64 fromLe64( char* );
LIBK3B_EXPORT bool isMounted( K3bDevice::Device* );
/**
* Tries to unmount the device ignoring its actual mounting state.
* This method uses both TDEIO::unmount and pumount if available.
*/
LIBK3B_EXPORT bool unmount( K3bDevice::Device* );
/**
* Tries to mount the medium. Since K3b does not gather any information
* about mount points the only methods used are pmount and HAL::mount
*/
LIBK3B_EXPORT bool mount( K3bDevice::Device* );
/**
* Ejects the medium in the device or simply opens the tray.
* This method improves over K3bDevice::Device::eject in that it
* unmounts before ejecting and introduces HAL support.
*/
LIBK3B_EXPORT bool eject( K3bDevice::Device* );
}
#endif