1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
JUCE/extras/Projucer/Source/Utility/Helpers/jucer_MiscUtilities.cpp

422 lines
12 KiB
C++

/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2017 - ROLI Ltd.
JUCE is an open source library subject to commercial or open-source
licensing.
By using JUCE, you agree to the terms of both the JUCE 5 End-User License
Agreement and JUCE 5 Privacy Policy (both updated and effective as of the
27th April 2017).
End User License Agreement: www.juce.com/juce-5-licence
Privacy Policy: www.juce.com/juce-5-privacy-policy
Or: You may also use this code under the terms of the GPL v3 (see
www.gnu.org/licenses).
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
DISCLAIMED.
==============================================================================
*/
#include "../../Application/jucer_Headers.h"
//==============================================================================
const char* getLineEnding() { return "\r\n"; }
String joinLinesIntoSourceFile (StringArray& lines)
{
while (lines.size() > 10 && lines [lines.size() - 1].isEmpty())
lines.remove (lines.size() - 1);
return lines.joinIntoString (getLineEnding()) + getLineEnding();
}
String trimCommentCharsFromStartOfLine (const String& line)
{
return line.trimStart().trimCharactersAtStart ("*/").trimStart();
}
String createAlphaNumericUID()
{
String uid;
const char chars[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
Random r;
uid << chars [r.nextInt (52)]; // make sure the first character is always a letter
for (int i = 5; --i >= 0;)
{
r.setSeedRandomly();
uid << chars [r.nextInt (62)];
}
return uid;
}
String hexString8Digits (int value)
{
return String::toHexString (value).paddedLeft ('0', 8);
}
String createGUID (const String& seed)
{
const String hex (MD5 ((seed + "_guidsalt").toUTF8()).toHexString().toUpperCase());
return "{" + hex.substring (0, 8)
+ "-" + hex.substring (8, 12)
+ "-" + hex.substring (12, 16)
+ "-" + hex.substring (16, 20)
+ "-" + hex.substring (20, 32)
+ "}";
}
String escapeSpaces (const String& s)
{
return s.replace (" ", "\\ ");
}
String addQuotesIfContainsSpaces (const String& text)
{
return (text.containsChar (' ') && ! text.isQuotedString()) ? text.quoted() : text;
}
void setValueIfVoid (Value value, const var& defaultValue)
{
if (value.getValue().isVoid())
value = defaultValue;
}
//==============================================================================
StringPairArray parsePreprocessorDefs (const String& text)
{
StringPairArray result;
auto s = text.getCharPointer();
while (! s.isEmpty())
{
String token, value;
s = s.findEndOfWhitespace();
while ((! s.isEmpty()) && *s != '=' && ! s.isWhitespace())
token << s.getAndAdvance();
s = s.findEndOfWhitespace();
if (*s == '=')
{
++s;
while ((! s.isEmpty()) && *s == ' ')
++s;
while ((! s.isEmpty()) && ! s.isWhitespace())
{
if (*s == ',')
{
++s;
break;
}
if (*s == '\\' && (s[1] == ' ' || s[1] == ','))
++s;
value << s.getAndAdvance();
}
}
if (token.isNotEmpty())
result.set (token, value);
}
return result;
}
StringPairArray mergePreprocessorDefs (StringPairArray inheritedDefs, const StringPairArray& overridingDefs)
{
for (int i = 0; i < overridingDefs.size(); ++i)
inheritedDefs.set (overridingDefs.getAllKeys()[i], overridingDefs.getAllValues()[i]);
return inheritedDefs;
}
String createGCCPreprocessorFlags (const StringPairArray& defs)
{
String s;
for (int i = 0; i < defs.size(); ++i)
{
auto def = defs.getAllKeys()[i];
auto value = defs.getAllValues()[i];
if (value.isNotEmpty())
def << "=" << value;
s += " -D" + def;
}
return s;
}
String replacePreprocessorDefs (const StringPairArray& definitions, String sourceString)
{
for (int i = 0; i < definitions.size(); ++i)
{
const String key (definitions.getAllKeys()[i]);
const String value (definitions.getAllValues()[i]);
sourceString = sourceString.replace ("${" + key + "}", value);
}
return sourceString;
}
StringArray getSearchPathsFromString (const String& searchPath)
{
StringArray s;
s.addTokens (searchPath, ";\r\n", StringRef());
return getCleanedStringArray (s);
}
StringArray getCommaOrWhitespaceSeparatedItems (const String& sourceString)
{
StringArray s;
s.addTokens (sourceString, ", \t\r\n", StringRef());
return getCleanedStringArray (s);
}
StringArray getCleanedStringArray (StringArray s)
{
s.trim();
s.removeEmptyStrings();
return s;
}
//==============================================================================
static bool keyFoundAndNotSequentialDuplicate (XmlElement* xml, const String& key)
{
forEachXmlChildElementWithTagName (*xml, element, "key")
{
if (element->getAllSubText().trim().equalsIgnoreCase (key))
{
if (element->getNextElement() != nullptr && element->getNextElement()->hasTagName ("key"))
{
// found broken plist format (sequential duplicate), fix by removing
xml->removeChildElement (element, true);
return false;
}
// key found (not sequential duplicate)
return true;
}
}
// key not found
return false;
}
static bool addKeyIfNotFound (XmlElement* xml, const String& key)
{
if (! keyFoundAndNotSequentialDuplicate (xml, key))
{
xml->createNewChildElement ("key")->addTextElement (key);
return true;
}
return false;
}
void addPlistDictionaryKey (XmlElement* xml, const String& key, const String& value)
{
if (addKeyIfNotFound (xml, key))
xml->createNewChildElement ("string")->addTextElement (value);
}
void addPlistDictionaryKeyBool (XmlElement* xml, const String& key, const bool value)
{
if (addKeyIfNotFound (xml, key))
xml->createNewChildElement (value ? "true" : "false");
}
void addPlistDictionaryKeyInt (XmlElement* xml, const String& key, int value)
{
if (addKeyIfNotFound (xml, key))
xml->createNewChildElement ("integer")->addTextElement (String (value));
}
//==============================================================================
void autoScrollForMouseEvent (const MouseEvent& e, bool scrollX, bool scrollY)
{
if (Viewport* const viewport = e.eventComponent->findParentComponentOfClass<Viewport>())
{
const MouseEvent e2 (e.getEventRelativeTo (viewport));
viewport->autoScroll (scrollX ? e2.x : 20, scrollY ? e2.y : 20, 8, 16);
}
}
//==============================================================================
int indexOfLineStartingWith (const StringArray& lines, const String& text, int index)
{
const int len = text.length();
for (const String* i = lines.begin() + index, * const e = lines.end(); i < e; ++i)
{
if (CharacterFunctions::compareUpTo (i->getCharPointer().findEndOfWhitespace(),
text.getCharPointer(), len) == 0)
return index;
++index;
}
return -1;
}
//==============================================================================
bool fileNeedsCppSyntaxHighlighting (const File& file)
{
if (file.hasFileExtension (sourceOrHeaderFileExtensions))
return true;
// This is a bit of a bodge to deal with libc++ headers with no extension..
char fileStart[128] = { 0 };
FileInputStream fin (file);
fin.read (fileStart, sizeof (fileStart) - 4);
return CharPointer_UTF8::isValidString (fileStart, sizeof (fileStart))
&& String (fileStart).trimStart().startsWith ("// -*- C++ -*-");
}
//==============================================================================
bool isJUCEModule (const String& moduleID) noexcept
{
static StringArray juceModuleIds =
{
"juce_analytics",
"juce_audio_basics",
"juce_audio_devices",
"juce_audio_formats",
"juce_audio_plugin_client",
"juce_audio_processors",
"juce_audio_utils",
"juce_blocks_basics",
"juce_box2d",
"juce_core",
"juce_cryptography",
"juce_data_structures",
"juce_dsp",
"juce_events",
"juce_graphics",
"juce_gui_basics",
"juce_gui_extra",
"juce_opengl",
"juce_osc",
"juce_product_unlocking",
"juce_video"
};
return juceModuleIds.contains (moduleID);
}
bool isValidExporterName (const String& exporterName) noexcept
{
static StringArray validExporters =
{
"XCODE_MAC",
"XCODE_IPHONE",
"VS2013",
"VS2015",
"VS2017",
"LINUX_MAKE",
"ANDROIDSTUDIO",
"CODEBLOCKS_WINDOWS",
"CODEBLOCKS_LINUX"
};
return validExporters.contains (exporterName);
}
String getTargetFolderForExporter (const String& exporterName) noexcept
{
if (exporterName == "XCODE_MAC") return "MacOSX";
if (exporterName == "XCODE_IPHONE") return "iOS";
if (exporterName == "VS2017") return "VisualStudio2017";
if (exporterName == "VS2015") return "VisualStudio2015";
if (exporterName == "VS2013") return "MacOVisualStudio2015SX";
if (exporterName == "LINUX_MAKE") return "LinuxMakefile";
if (exporterName == "ANDROIDSTUDIO") return "Android";
if (exporterName == "CODEBLOCKS_WINDOWS") return "CodeBlocksWindows";
if (exporterName == "CODEBLOCKS_LINUX") return "CodeBlocksLinux";
return {};
}
StringArray getModulesRequiredForConsole() noexcept
{
return { "juce_core",
"juce_data_structures",
"juce_events"
};
}
StringArray getModulesRequiredForComponent() noexcept
{
return { "juce_core",
"juce_data_structures",
"juce_events",
"juce_graphics",
"juce_gui_basics"
};
}
StringArray getModulesRequiredForAudioProcessor() noexcept
{
return { "juce_audio_basics",
"juce_audio_devices",
"juce_audio_formats",
"juce_audio_plugin_client",
"juce_audio_processors",
"juce_audio_utils",
"juce_core",
"juce_data_structures",
"juce_events",
"juce_graphics",
"juce_gui_basics",
"juce_gui_extra"
};
}
bool isPIPFile (const File& file) noexcept
{
for (auto line : StringArray::fromLines (file.loadFileAsString()))
{
auto trimmedLine = trimCommentCharsFromStartOfLine (line);
if (trimmedLine.startsWith ("BEGIN_JUCE_PIP_METADATA"))
return true;
}
return false;
}
File getJUCEExamplesDirectoryPathFromGlobal() noexcept
{
auto globalPath = getAppSettings().getStoredPath (Ids::jucePath).toString();
if (globalPath.isNotEmpty())
return File (getAppSettings().getStoredPath (Ids::jucePath).toString()).getChildFile ("examples");
return {};
}
bool isValidJUCEExamplesDirectory (const File& directory) noexcept
{
if (! directory.exists() || ! directory.isDirectory() || ! directory.containsSubDirectories())
return false;
return directory.getChildFile ("Assets").getChildFile ("juce_icon.png").existsAsFile();
}