""" The miscellaneous module. This module contains miscellaneous functions for expyriment. All classes in this module should be called directly via expyriment.misc.*: """ __author__ = 'Florian Krause , \ Oliver Lindemann ' __version__ = '0.7.0' __revision__ = '55a4e7e' __date__ = 'Wed Mar 26 14:33:37 2014 +0100' import sys import os try: import locale except ImportError: locale = None # Not available on Android import glob import pygame def compare_codes(input_code, standard_codes, bitwise_comparison=True): """Helper function to compare input_code with a standard codes. Returns a boolean and operates by default bitwise. Parameters ---------- input_code : int code or bitpattern standard_codes : int or list code/bitpattern or list of codes/bitpattern bitwise_comparison : bool, optional (default = True) """ if type(standard_codes) is list: for code in standard_codes: if compare_codes(input_code, code, bitwise_comparison): return True return False else: if input_code == standard_codes: # accounts also for (bitwise) 0==0 & # None==None return True elif bitwise_comparison: return (input_code & standard_codes) else: return False def str2unicode(s, fse=False): """Convert str to unicode. Converts an input str or unicode object to a unicode object without throwing an exception. If fse is False, the first encoding that is tried is the encoding according to the locale settings, falling back to utf-8 encoding if this throws an error. If fse is True, the filesystem encoding is tried, falling back to utf-8. Unicode input objects are return unmodified. Parameters ---------- s : str or unicode input text fse : bool indicates whether the filesystem encoding should be tried first. (default = False) Returns ------- A unicode-type string. """ if isinstance(s, unicode): return s try: locale_enc = locale.getdefaultlocale()[1] except: locale_enc = None if locale_enc is None: locale_enc = u'utf-8' fs_enc = sys.getfilesystemencoding() if fs_enc is None: fs_enc = u'utf-8' if fse: try: u = s.decode(fs_enc) except UnicodeDecodeError: u = s.decode(u'utf-8', u'replace') else: try: u = s.decode(locale_enc) except UnicodeDecodeError: u = s.decode(u'utf-8', u'replace') return u def unicode2str(u, fse=False): """Convert unicode to str. Converts an input str or unicode object to a str object without throwing an exception. If fse is False, the str is encoded according to the locale (with utf-8 as a fallback), otherwise it is encoded with the filesystemencoding. Str input objects are return unmodified. Parameters ---------- u : str or unicode input text fse : bool indicates whether the filesystem encoding should used. (default = False) Returns ------- A str-type string. """ if isinstance(u, str): return u try: locale_enc = locale.getdefaultlocale()[1] except: locale_enc = None if locale_enc is None: locale_enc = u'utf-8' fs_enc = sys.getfilesystemencoding() if fs_enc is None: fs_enc = u'utf-8' if fse: try: s = u.encode(fs_enc) except UnicodeEncodeError: s = u.encode(u'utf-8', u'replace') else: try: s = u.encode(locale_enc) except UnicodeEncodeError: s = u.encode(u'uff-8', u'replace') return s def add_fonts(folder): """Add fonts to Expyriment. All truetype fonts found in the given folder will be added to Expyriment, such that they are found when only giving their name (i.e. without the full path). Parameters ---------- folder : str or unicode the full path to the folder to search for """ pygame.font.init() pygame.sysfont.initsysfonts() for font in glob.glob(os.path.join(folder, "*")): if font[-4:].lower() in ['.ttf', '.ttc']: font = str2unicode(font, fse=True) name = os.path.split(font)[1] bold = name.find('Bold') >= 0 italic = name.find('Italic') >= 0 oblique = name.find('Oblique') >= 0 name = name.replace(".ttf", "") if name.endswith("Regular"): name = name.replace("Regular", "") if name.endswith("Bold"): name = name.replace("Bold", "") if name.endswith("Italic"): name = name.replace("Italic", "") if name.endswith("Oblique"): name = name.replace("Oblique", "") name = ''.join([c.lower() for c in name if c.isalnum()]) pygame.sysfont._addfont(name, bold, italic or oblique, font, pygame.sysfont.Sysfonts) def list_fonts(): """List all fonts installed on the system. Returns a dictionary where the key is the font name and the value is the absolute path to the font file. """ pygame.font.init() d = {} fonts = pygame.font.get_fonts() for font in fonts: d[font] = pygame.font.match_font(font) return d def find_font(font): """Find an installed font given a font name. This will try to match a font installed on the system that is similar to the given font name. Parameters ---------- font : str name of the font Returns ------- font : str the font that is most similar If no font is found, an empty string will be returned. """ pygame.font.init() try: if os.path.isfile(font): pygame.font.Font(unicode2str(font, fse=True), 10) else: pygame.font.Font(unicode2str(font), 10) return font except: font_file = pygame.font.match_font(font) if font_file is not None: return font_file else: return ""