Aegisub/aegisub/src/utils.cpp
Thomas Goyne ffa622d698 Fix compilation without precompiled headers
Originally committed to SVN as r5791.
2011-10-28 20:15:10 +00:00

466 lines
12 KiB
C++

// Copyright (c) 2005-2006, Rodrigo Braz Monteiro
// All rights reserved.
//
// 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 following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without 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
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL 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.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$
/// @file utils.cpp
/// @brief Misc. utility functions
/// @ingroup utility
///
///////////
// Headers
#include "config.h"
#ifndef AGI_PRE
#ifdef __UNIX__
#include <unistd.h>
#endif
#include <wx/dcmemory.h>
#include <wx/filename.h>
#include <wx/log.h>
#include <wx/stdpaths.h>
#include <wx/window.h>
#endif
#include <libaegisub/log.h>
#ifdef __APPLE__
#include <libaegisub/util_osx.h>
#endif
#include "utils.h"
#ifndef __LINUX__
/// @brief Absolute of 64 bit int
/// @param input
/// @return
///
int64_t abs64(int64_t input) {
if (input < 0) return -input;
return input;
}
#endif
/// @brief Count number of matches of a substr
/// @param parent
/// @param child
/// @return
///
int CountMatches(wxString parent,wxString child) {
size_t pos = wxString::npos;
int n = 0;
while ((pos = parent.find(child,pos+1)) != wxString::npos) n++;
return n;
}
/// @brief Make a path relative to reference
/// @param _path
/// @param reference
/// @return
///
wxString MakeRelativePath(wxString _path,wxString reference) {
if (_path.IsEmpty()) return "";
if (_path.Left(1) == "?") return _path;
wxFileName path(_path);
wxFileName refPath(reference);
path.MakeRelativeTo(refPath.GetPath());
return path.GetFullPath();
}
/// @brief Extract original path from relative
/// @param _path
/// @param reference
/// @return
///
wxString DecodeRelativePath(wxString _path,wxString reference) {
if (_path.IsEmpty()) return "";
if (_path.Left(1) == "?") return _path;
wxFileName path(_path);
wxFileName refPath(reference);
if (!path.IsAbsolute()) path.MakeAbsolute(refPath.GetPath());
#ifdef __UNIX__
return path.GetFullPath(wxPATH_UNIX); // also works on windows
// No, it doesn't, this ommits drive letter in Windows. ~ amz
#else
return path.GetFullPath();
#endif
}
/// @brief Float to string
/// @param value
/// @return
///
wxString AegiFloatToString(double value) {
return wxString::Format("%g",value);
}
/// @brief Int to string
/// @param value
/// @return
///
wxString AegiIntegerToString(int value) {
return wxString::Format("%i",value);
}
/// @brief There shall be no kiB, MiB stuff here Pretty reading of size
/// @param bytes
/// @return
///
wxString PrettySize(int bytes) {
// Suffixes
wxArrayString suffix;
suffix.Add("");
suffix.Add(" kB");
suffix.Add(" MB");
suffix.Add(" GB");
suffix.Add(" TB");
suffix.Add(" PB");
// Set size
int i = 0;
double size = bytes;
while (size > 1024) {
size = size / 1024.0;
i++;
if (i == 6) {
i--;
break;
}
}
// Set number of decimal places
wxString final;
if (size < 10) final = wxString::Format("%.2f",size);
else if (size < 100) final = wxString::Format("%.1f",size);
else final = wxString::Format("%.0f",size);
return final + suffix[i];
}
/// @brief Code from http://bob.allegronetwork.com/prog/tricks.html Get the smallest power of two that is greater or equal to x
/// @param x
/// @return
///
int SmallestPowerOf2(int x) {
x--;
x |= (x >> 1);
x |= (x >> 2);
x |= (x >> 4);
x |= (x >> 8);
x |= (x >> 16);
x++;
return x;
}
/// @brief Get word boundaries
/// @param text
/// @param results
/// @param start
/// @param end
///
void GetWordBoundaries(const wxString text,IntPairVector &results,int start,int end) {
// Variables
wxChar cur;
int curPos;
int lastpos = -1;
int depth = 0;
if (end < 0) end = text.Length();
bool isDelim;
// Delimiters
const wchar_t delim_chars[] = {
0x0020, 0x0021, 0x0022, 0x0023, 0x0024, 0x0025, 0x0026, 0x0028,
0x0029, 0x002a, 0x002b, 0x002c, 0x002d, 0x002e, 0x002f, 0x003a,
0x003b, 0x003d, 0x003f, 0x0040, 0x005b, 0x005c, 0x005d, 0x005e,
0x005f, 0x0060, 0x007b, 0x007c, 0x007d, 0x007e, 0x00a1, 0x00a2,
0x00a3, 0x00a4, 0x00a5, 0x00a6, 0x00a7, 0x00a8, 0x00aa, 0x00ab,
0x00b0, 0x00b6, 0x00b7, 0x00ba, 0x00bb, 0x00bf, 0x02dc, 0x0e3f,
0x2010, 0x2013, 0x2014, 0x2015, 0x2018, 0x2019, 0x201c, 0x201d,
0x2020, 0x2021, 0x2022, 0x2025, 0x2026, 0x2026, 0x2030, 0x2031,
0x2032, 0x203b, 0x203b, 0x203d, 0x2042, 0x2044, 0x20a6, 0x20a9,
0x20aa, 0x20ac, 0x20ad, 0x2116, 0x2234, 0x2235, 0x2420, 0x2422,
0x2423, 0x2506, 0x25ca, 0x2605, 0x261e, 0x2e2e, 0x3000, 0x3001,
0x3002, 0x3008, 0x3009, 0x300a, 0x300b, 0x300c, 0x300d, 0x300e,
0x300f, 0x3010, 0x3011, 0x3014, 0x3015, 0x3016, 0x3017, 0x3018,
0x3019, 0x301a, 0x301b, 0x301c, 0x3030, 0x303d, 0x30fb, 0xff0a,
0xff5b, 0xff5d, 0xff5e, 0
};
wxString delim(delim_chars);
// Scan
for (int i=start;i<end+1;i++) {
// Current character
curPos = i;
if (i < end) cur = text[i];
else cur = '.';
isDelim = false;
// Increase depth
if (cur == '{') {
depth++;
if (depth == 1) {
if (lastpos+1 != curPos) {
results.push_back(std::pair<int,int>(lastpos+1,curPos));
}
continue;
}
}
// Decrease depth
if (cur == '}') {
depth--;
if (depth == 0) {
lastpos = i;
continue;
}
}
// Wrong depth
if (depth != 0) continue;
// Check if it is \n or \N
if (cur == '\\' && i < end-1 && (text[i+1] == 'N' || text[i+1] == 'n' || text[i+1] == 'h')) {
isDelim = true;
i++;
}
// Check for standard delimiters
if (delim.Find(cur) != wxNOT_FOUND) {
isDelim = true;
}
// Is delimiter?
if (isDelim) {
if (lastpos+1 != curPos) {
results.push_back(std::pair<int,int>(lastpos+1,curPos));
}
lastpos = i;
}
}
}
/// @brief Determine whether wchar 'c' is a whitespace character
/// @param c
/// @return
///
bool IsWhitespace(wchar_t c)
{
const wchar_t whitespaces[] = {
// http://en.wikipedia.org/wiki/Space_(punctuation)#Table_of_spaces
0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x0020, 0x0085, 0x00A0,
0x1680, 0x180E, 0x2000, 0x2001, 0x2002, 0x2003, 0x2004, 0x2005,
0x2006, 0x2007, 0x2008, 0x2009, 0x200A, 0x2028, 0x2029, 0x202F,
0x025F, 0x3000, 0xFEFF
};
const size_t num_chars = sizeof(whitespaces) / sizeof(whitespaces[0]);
for (size_t i = 0; i < num_chars; ++i)
if (whitespaces[i] == c)
return true;
return false;
}
/// @brief Returns true if str is empty of consists of only whitespace
/// @param str
/// @return
///
bool StringEmptyOrWhitespace(const wxString &str)
{
for (size_t i = 0; i < str.size(); ++i)
if (!IsWhitespace(str[i]))
return false;
return true;
}
/// @brief wxString::ToLong() is slow and not as flexible String to integer
/// @param str
/// @param start
/// @param end
/// @return
///
int AegiStringToInt(const wxString &str,int start,int end) {
// Initialize to zero and get length if end set to -1
int sign = 1;
int value = 0;
if (end == -1) end = str.Length();
for (int pos=start;pos<end;pos++) {
// Get value and check if it's a number
int val = (int)(str[pos]);
if (val == ' ' || val == '\t') continue;
if (val == '-') sign = -1;
if (val < '0' || val > '9') break;
// Shift value to next decimal place and increment the value just read
value = value * 10 + (val - '0');
}
return value*sign;
}
/// @brief String to fixed point
/// @param str
/// @param decimalPlaces
/// @param start
/// @param end
/// @return
///
int AegiStringToFix(const wxString &str,size_t decimalPlaces,int start,int end) {
// Parts of the number
int sign = 1;
int major = 0;
int minor = 0;
if (end == -1) end = str.Length();
bool inMinor = false;
int *dst = &major;
size_t mCount = 0;
for (int pos=start;pos<end;pos++) {
// Get value and check if it's a number
int val = (int)(str[pos]);
if (val == ' ' || val == '\t') continue;
if (val == '-') sign = -1;
// Switch to minor
if (val == '.' || val == ',') {
if (inMinor) break;
inMinor = true;
dst = &minor;
mCount = 0;
continue;
}
if (val < '0' || val > '9') break;
*dst = (*dst * 10) + (val - '0');
mCount++;
}
// Change minor to have the right number of decimal places
while (mCount > decimalPlaces) {
minor /= 10;
mCount--;
}
while (mCount < decimalPlaces) {
minor *= 10;
mCount++;
}
// Shift major and return
for (size_t i=0;i<decimalPlaces;i++) major *= 10;
return (major + minor)*sign;
}
/// @brief This is needed because wxIcon has to be 16x16 to work properly on win32 Convert a wxBitmap to wxIcon
/// @param iconBmp
/// @return
///
wxIcon BitmapToIcon(wxBitmap iconBmp) {
// Create the icon and background bmp
wxIcon ico;
wxBitmap bmp(16,16);
// Blit bitmap into 16x16 one (don't remove brackets)
{
wxMemoryDC dc;
dc.SelectObject(bmp);
dc.SetBackground(wxColour(192,192,192));
dc.Clear();
dc.DrawBitmap(iconBmp,0,0,false);
}
// Create mask and convert to icon
wxMask *mask = new wxMask(bmp,wxColour(192,192,192));
bmp.SetMask(mask);
ico.CopyFromBitmap(bmp);
return ico;
}
/// @brief just before this is called. It is assumed that something has prepared closing the current instance Start Aegisub again
///
void RestartAegisub() {
#if defined(__WXMSW__)
wxStandardPaths stand;
wxExecute("\"" + stand.GetExecutablePath() + "\"");
#elif defined(__WXMAC__)
char *bundle_path = agi::util::OSX_GetBundlePath();
char *support_path = agi::util::OSX_GetBundleSupportFilesDirectory();
if (!bundle_path || !support_path) return; // oops
wxString exec = wxString::Format("\"%s/MacOS/restart-helper\" /usr/bin/open -n \"%s\"'", wxString(support_path, wxConvUTF8), wxString(bundle_path, wxConvUTF8));
LOG_I("util/restart/exec") << exec;
wxExecute(exec);
free(bundle_path);
free(support_path);
#else
wxStandardPaths stand;
wxExecute(stand.GetExecutablePath());
#endif
}
bool ForwardMouseWheelEvent(wxWindow *source, wxMouseEvent &evt) {
wxWindow *target = wxFindWindowAtPoint(wxGetMousePosition());
if (!target || target == source) return true;
// If the mouse is over a parent of the source window just pretend it's
// over the source window, so that the mouse wheel works on borders and such
wxWindow *parent = source->GetParent();
while (parent && parent != target) parent = parent->GetParent();
if (parent == target) return true;
// Otherwise send it to the new target
target->GetEventHandler()->ProcessEvent(evt);
evt.Skip(false);
return false;
}