Use Emoji One SVGs for our flag icons instead of FamFamFam.

While the FamFamFam icons have served us well, we really
need SVG flag icons for HiDPI scenarios.

This is one of the last pieces missing to allow us to
claim we fully support Retina displays on OS X.

1 files changed, 109 insertions, 0 deletions

diff --git a/scripts/extract-emojione-flags.py b/scripts/extract-emojione-flags.py
new file mode 100755
index 000000000..defac3495
--- /dev/null
+++ b/scripts/extract-emojione-flags.py
@@ -0,0 +1,109 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2015, Mikkel Krautz <mikkel@krautz.dk>
+#
+# 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 Mumble Developers 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 FOUNDATION 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.
+#
+#
+# extract-emojione-flags.py
+# Extract SVG flags from the Emoji One emoji collection.
+#
+# This script walks the Emoji One SVG collection and extracts
+# flag emojis.
+#
+# Emoji One's emojis all use the Unicode code points (base 16) as
+# their on-disk names. If a character consists of multiple code points,
+# they are separated by a dash ('-').
+#
+# This script walks all the Emoji One SVGs, and finds the ones which
+# only contain symbols in the Regional Indicator Symbol range.
+# These are flag emojis.
+#
+# The flags are then copied to the destination directory, and named
+# as the region's lower case ISO_3166-1_alpha-2 code with the ".svg"
+# extension.
+
+from __future__ import (unicode_literals, print_function, division)
+
+import os
+import shutil
+import sys
+
+# Beginning and end of the Regional Indicator Symbol range,
+# as defined by Unicode 6.0's emoji support.
+#
+# See https://en.wikipedia.org/wiki/Regional_Indicator_Symbol
+# for more information.
+REGIONAL_INDICATOR_SYMBOL_LETTER_A = 0x1F1E6
+REGIONAL_INDICATOR_SYMBOL_LETTER_Z = 0x1F1FF
+
+def is_region(points):
+	for point in points:
+		if point > REGIONAL_INDICATOR_SYMBOL_LETTER_Z \
+		   or point < REGIONAL_INDICATOR_SYMBOL_LETTER_A:
+			return False	
+	return True
+
+def region_name(points):
+	name = ''
+	for point in points:
+		name += chr(point - REGIONAL_INDICATOR_SYMBOL_LETTER_A + ord('a'))
+	return name
+
+def main():
+	if len(sys.argv) < 3:
+		print('''Usage: extract-emojione-flags.py [emojione-svg-dir] [dst-dir]
+
+emojione-svg-dir: point this to the directory containing Emoji One SVGs, such as
+                  $EMOJIONE_SRC_TREE/assets/svg.
+
+dst-dir: point this to the directory you want the resulting SVGs to be written to.
+
+''')
+		sys.exit(1)
+
+	emojiOneSvgDir = sys.argv[1]
+	dstDir = sys.argv[2]
+
+	files = os.listdir(emojiOneSvgDir)
+	for fn in files:
+		base, ext = os.path.splitext(fn.lower())
+		if not ext == '.svg':
+			continue
+		
+		pointsStr = base.split('-')
+		points = [int(p, 16) for p in pointsStr]
+		
+		if is_region(points):
+			name = region_name(points)
+			svgName = name + '.svg'
+			shutil.copy(os.path.join(emojiOneSvgDir, fn),
+			            os.path.join(dstDir, svgName))
+
+if __name__ == '__main__':
+	main()