Improved MEX Compilation

.gitignore

@@ -37,3 +37,6 @@ rebuildTags.sh
 
 # caused py setup.py develop
 pymatbridge.egg-info
+
+.idea/**
+dist/**

LICENSE

@@ -1,3 +1,33 @@
+Pymatbridge
+===========
+
+A python interface to call out to Matlab(R).
+
+
+License information
+===================
+
+Copyright (c) 2012 -- , Max Jaderberg, Ariel Rokem, Haoxing Zhao
+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 Oxford University, Stanford University 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 HOLDER 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.
+
+
 Copyright (c) 2013. See "Contributors". MATLAB (R) is copyright of the Mathworks. 
 
 All rights reserved.

config.ini

@@ -0,0 +1,20 @@
+[Darwin]
+; MATLAB_BIN=Applications/MATLAB_R2014a.app/bin
+; OCTAVE_INC=
+; OCTAVE_LIB=
+ZMQ_INC=/usr/local/include
+ZMQ_LIB=/usr/local/lib
+
+[Windows]
+; MATLAB_BIN=C:\Program Files\MATLAB\R2014b\bin
+; OCTAVE_INC=C:\Octave\Octave-3.8.2\include\octave-3.8.2\octave
+; OCTAVE_LIB=C:\Octave\Octave-3.8.2\lib\octave\3.8.2
+ZMQ_INC=C:/Program Files/ZeroMQ 4.0.4/include
+ZMQ_LIB=C:/Program Files/ZeroMQ 4.0.4/lib
+
+[Linux]
+; MATLAB_BIN=/usr/local/bin
+; OCTAVE_INC=/usr/include
+; OCTAVE_LIB=/usr/lib/x86_64-linux-gnu/
+ZMQ_INC=
+ZMQ_LIB=

messenger/__init__.py

@@ -0,0 +1,2 @@
+from .settings import *
+from .make import *

messenger/__main__.py

@@ -0,0 +1,41 @@
+import sys
+
+from argparse import ArgumentParser
+
+from .make import *
+
+def command_line():
+    """
+    Manages command line arguments.
+
+    Returns
+    =======
+    Namespace containing parsed arguments
+    """
+    parser = ArgumentParser(prog='messenger')
+
+    parser.add_argument(
+        "target",
+        choices=["matlab", "octave"],
+        type=str.lower,
+        help="target to be built"
+    )
+    parser.add_argument(
+        "--static",
+        action="store_true",
+        help="statically link libzmq"
+    )
+    return parser.parse_args()
+
+def main():
+    args   = command_line()
+    build  = {
+        'matlab': build_matlab,
+        'octave': build_octave,
+    }
+    target = build[args.target]
+
+    return target(static=args.static)
+
+if __name__ == '__main__':
+    sys.exit(main())

messenger/make.py

@@ -1,112 +1,133 @@
-#!/usr/bin/python
 from __future__ import print_function
+
 import os
-import platform
 import sys
 import shlex
 import shutil
 import subprocess
+import platform
+import glob
+
+try:
+    from ConfigParser import ConfigParser
+except ImportError:
+    from configparser import ConfigParser
+
+from . import settings
 
+__all__ = [
+    'get_messenger_dir',
+    'get_matlab_bin',
+    'get_config',
+    'do_build',
+    'build_octave',
+    'build_matlab'
+]
 
 def get_messenger_dir():
-    # Check the system platform first
-    splatform = sys.platform
-
-    if splatform.startswith('linux'):
-        messenger_dir = 'mexa64'
-    elif splatform.startswith('darwin'):
-        messenger_dir = 'mexmaci64'
-    elif splatform.startswith('win32'):
-        if splatform == "win32":
-            # We have a win64 messenger, so we need to figure out if this is 32
-            # or 64 bit Windows:
-            if not platform.machine().endswith('64'):
-                raise ValueError("pymatbridge does not work on win32")
-
-        # We further need to differniate 32 from 64 bit:
-        maxint = sys.maxsize
-        if maxint == 9223372036854775807:
-            messenger_dir = 'mexw64'
-        elif maxint == 2147483647:
-            messenger_dir = 'mexw32'
-    return messenger_dir
-
-
-def get_config():
-    messenger_dir = get_messenger_dir()
-    with open(os.path.join(messenger_dir, 'local.cfg')) as fid:
-        lines = fid.readlines()
+    host, is_64bit = platform.system(), sys.maxsize > 2**32
+    ostype = {
+        'Darwin':  'mexmaci64',
+        'Linux':   'mexa64',
+        'Windows': 'mexw64',
+    }
+    if not is_64bit and host == 'Windows':
+        raise ValueError("pymatbridge does not support 32-bit Windows")
+
+    return ostype[host] if is_64bit else 'mexw32'
+
+
+def get_config(host, config='config.ini'):
+
+    cfg = ConfigParser()
+    cfg.read(config)
 
-    cfg = {}
-    for line in lines:
-        if '=' not in line:
-            continue
-        name, path = line.split('=')
-        cfg[name.lower()] = path.strip() or '.'
-    return cfg
+    return dict(cfg.items(host))
 
 
 def do_build(make_cmd, messenger_exe):
     print('Building %s...' % messenger_exe)
     print(make_cmd)
     messenger_dir = get_messenger_dir()
-    subprocess.check_output(shlex.split(make_cmd), shell=True)
+    subprocess.call(shlex.split(make_cmd), stderr=subprocess.STDOUT)
 
     messenger_loc = os.path.join(messenger_dir, messenger_exe)
 
-    shutil.move(messenger_exe, messenger_loc)
+    shutil.move(messenger_exe, os.path.join('messenger', messenger_loc))
 
-    if os.path.exists('messenger.o'):
+    if os.path.isfile('messenger.o'):
         os.remove('messenger.o')
 
 
-def build_octave():
+def build_octave(static=False):
     paths = "-L%(octave_lib)s -I%(octave_inc)s -L%(zmq_lib)s -I%(zmq_inc)s"
-    paths = paths % get_config()
+    paths = paths % get_config(platform.system())
     make_cmd = "mkoctfile --mex %s -lzmq ./src/messenger.c" % paths
     do_build(make_cmd, 'messenger.mex')
 
 
 def build_matlab(static=False):
-    """build the messenger mex for MATLAB
-
+    """
+    Build the messenger mex for MATLAB
+
+    Parameters
+    ============
     static : bool
         Determines if the zmq library has been statically linked.
         If so, it will append the command line option -DZMQ_STATIC
         when compiling the mex so it matches libzmq.
     """
-    cfg = get_config()
-    # To deal with spaces, remove quotes now, and add
-    # to the full commands themselves.
-    matlab_bin = cfg['matlab_bin'].strip('"')
-    # Get the extension
-    extcmd = '"' + os.path.join(matlab_bin, "mexext") + '"'
-    extension = subprocess.check_output(extcmd, shell=True)
-    extension = extension.decode('utf-8').rstrip('\r\n')
+    matlab_bin, cfg = settings.get_matlab_bin(), get_config(platform.system())
+
+    extcmd     = '%s' % os.path.join(matlab_bin, "mexext")
+    extension  = subprocess.check_output(extcmd, shell=True)
+    extension  = extension.decode('utf-8').rstrip()
 
     # Build the mex file
     mex = '"' + os.path.join(matlab_bin, "mex") + '"'
-    paths = "-L%(zmq_lib)s -I%(zmq_inc)s" % cfg
-    make_cmd = '%s -O %s -lzmq ./src/messenger.c' % (mex, paths)
+    paths    = "-L'%(zmq_lib)s' -I'%(zmq_inc)s'" % cfg
+    make_cmd = '%s -O %s -lzmq messenger/src/messenger.c' % (mex, paths)
+
     if static:
         make_cmd += ' -DZMQ_STATIC'
+
     do_build(make_cmd, 'messenger.%s' % extension)
 
 
-if __name__ == '__main__':
-    import argparse
-    parser = argparse.ArgumentParser()
-    parser.add_argument(
-        "target",
-        choices=["matlab", "octave"],
-        type=str.lower,
-        help="target to be built")
-    parser.add_argument("--static", action="store_true",
-                        help="staticly link libzmq")
-    args = parser.parse_args()
-    if args.target == "matlab":
-        build_matlab(static=args.static)
-    elif args.target == "octave":
-        build_octave()
+def get_matlab_bin(config='config.ini'):
+    """
+    Tries to find the MATLAB bin directory independent on host platform.
+    The operation of this function can be overridden by setting the MATLAB_BIN
+    variable within the configuration file specified.
+
+    Parameters
+    -=========
+    config:
+        Relative path to configuration file
+
+    Returns
+    =======
+    matlab:
+        Absolute path to matlab bin directory
+    """
+    host = platform.system()
+    cfg  = get_config(host)
+    programs = {
+        'Darwin' : r'/Applications',
+        'Windows': r'C:/Program Files',
+        'Linux'  : r'/usr/local',
+        }
+
+    if cfg.get('MATLAB_BIN', None):
+        matlab = cfg['MATLAB_BIN']
     else:
-        raise ValueError()
+        # Searches for Matlab bin if it's not set
+        _root    = glob.glob(r'%s/MATLAB*' % programs[host])[0]
+        _version = [p for p in os.listdir(_root) if p.startswith('R20')]
+        if _version:
+            _root = r'%s/%s' % (_root, _version.pop())
+        matlab   = r'%s/%s' % (_root, 'bin')
+
+    assert os.path.isdir(matlab)
+
+    return os.path.normpath(matlab)

messenger/settings.py

@@ -0,0 +1,55 @@
+import os
+import subprocess
+import logging
+import tarfile
+
+try:
+    from urllib.request import urlretrieve
+except ImportError:
+    from urllib import urlretrieve
+
+__all__= ['get_matlab_env', 'fetch_zmq']
+
+def get_matlab_env(matlab='matlab'):
+    """
+    Get the underlying environment variables set for a matlab installation.
+
+    Parameters
+    ==========
+    matlab: string
+        Path to the matlab binary executable.
+        If matlab is in the users $PATH, just pass 'matlab'
+
+    Returns
+    =======
+    environment: dictionary
+        Mapping of environment variable[s]
+    """
+    command = ' '.join([matlab, '-e']),
+    process = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
+
+    envs    = (line.decode('utf-8').strip() for line in process.stdout)
+
+    return dict(env.split('=', maxsplit=1) for env in envs)
+
+def fetch_zmq(prefix, version=(4,0,5)):
+    """
+    Download and extract libzmq
+
+    Parameters
+    ==========
+    save: str
+        File Save Location
+    version: tuple
+        ZMQ Version Number
+    """
+    print('Downloading ZMQ Source Version %i.%i.%i'      % version)
+    url = ("http://download.zeromq.org/zeromq-%i.%i.%i.tar.gz" % version)
+    name = urlretrieve(url, url.rsplit('/')[-1])[0]
+
+    print('Extracting into prefix %s' % prefix)
+    with tarfile.open(name) as tar:
+        tar.extractall(prefix)
+
+    print('Download Complete')
+    os.remove(name)