Added more logic to cg_to_glsl converter to find cgc in o3d/third_party/cgc/...

cg_to_glsl/convert.py

 #!/usr/bin/python
 import optparse
 import os
 import re
 import subprocess
 import sys
 
 # This script takes an o3d cg shader from standard input and does the following:
 #
 # * it extracts entry points to vertex and fragment shaders as specified by
@@ skipping 10 matching lines @@
 # * renames gl_Vertex and gl_MultiTexCoordN to position and texcoordN
 #   respectively and adds attribute declarations;
 #
 # * prints the results to standard output, separating them with SplitMarker
 #   instruction and keeping the MatrixLoadOrder instruction as is.
 
 # Cygwin lies about the OS name ("posix" instead of "nt"), the line
 # separator, and perhaps other things. For most robust behavior, try
 # to find cgc on disk.
 
-CGC = '/usr/bin/cgc'
-if not os.path.exists(CGC):
-  CGC = 'c:/Program Files (x86)/NVIDIA Corporation/Cg/bin/cgc.exe'
+def find_o3d_root():
+  path = os.path.abspath(sys.path[0])
+  for i in range(0, 5):

[Alexey Marinichev, 2010/04/27 21:28:16]

range(5)

[Ken Russell (switch to Gerrit), 2010/04/28 02:30:49]

Done. Will send you a separate CL with this and the other changes.

+    path = os.path.dirname(path)
+    if (os.path.isdir(os.path.join(path, 'o3d')) and
+        os.path.isdir(os.path.join(path, 'third_party'))):
+      return path
+  return ''
+
+def default_cgc():
+  paths = [ '/usr/bin/cgc',

[Alexey Marinichev, 2010/04/27 21:28:16]

Does chrome style prefer "[ x ]" over "[x]"?

[Ken Russell (switch to Gerrit), 2010/04/28 02:30:49]

Not sure. I'll get rid of the surrounding spaces.

+            'C:/Program Files/NVIDIA Corporation/Cg/bin/cgc.exe',
+            'C:/Program Files (x86)/NVIDIA Corporation/Cg/bin/cgc.exe' ]
+  for path in paths:
+    if os.path.exists(path):
+      return path
+  script_path = os.path.abspath(sys.path[0])
+  # Try again looking in the current working directory to match
+  # the layout of the prebuilt o3dConverter binaries.
+  cur_dir_paths = [ os.path.join(script_path, 'cgc'),
+                    os.path.join(script_path, 'cgc.exe') ]
+  for path in cur_dir_paths:
+    if (os.path.exists(path)):
+      return path
+
+  # Last fallback is to use the binaries in o3d/third_party/cg/files.
+  # Unfortunately, because we can't rely on the OS name, we have to
+  # actually try running the cgc executable.
+  o3d_root = find_o3d_root();
+  cg_root = os.path.join(o3d_root, 'third_party', 'cg', 'files')

[Alexey Marinichev, 2010/04/27 21:28:16]

'third_party/cg/files' would be more readable.

[Ken Russell (switch to Gerrit), 2010/04/28 02:30:49]

Unclear to me whether that is guaranteed to be functionally equivalent.

+  exes = [ os.path.join(cg_root, 'linux', 'bin', 'cgc'),
+           os.path.join(cg_root, 'linux', 'bin64', 'cgc'),
+           os.path.join(cg_root, 'mac', 'bin', 'cgc'),
+           os.path.join(cg_root, 'win', 'bin', 'cgc.exe') ]
+  for exe in exes:

[Alexey Marinichev, 2010/04/27 21:28:16]

relative_paths = ['linux/bin/cgc', ....]
for exe in (os.path.join(cgc_root, relative_paths)):
 ...

[Alexey Marinichev, 2010/04/27 23:24:09]

Um, that's not exactly what I meant...  You can call os.path.join inside the
loop.
On 2010/04/27 21:28:16, Alexey Marinichev wrote:

[Ken Russell (switch to Gerrit), 2010/04/28 02:30:49]

See above regarding my concern about funcional equivalence in particular on
non-Cygwin versions of Python on Windows.

+    try:
+      subprocess.call([exe, '-v'],
+                      stdout=open(os.devnull, 'w'),
+                      stderr=open(os.devnull, 'w'))

[Alexey Marinichev, 2010/04/27 21:28:16]

Is checking if the path exists not enough?  Do you really have to try to execute
it?

[Ken Russell (switch to Gerrit), 2010/04/28 02:30:49]

Unfortunately it's not enough. All three versions live in workspaces checked out
on any of these three platforms.

+      return exe
+    except:
+      pass
+
+  # We don't know where cgc lives.
+  return ''
+
+def check_cgc(CGC):
   if not os.path.exists(CGC):
-    CGC = 'c:/Program Files (x86)/NVIDIA Corporation/Cg/bin/cgc.exe'
-    if not os.path.exists(CGC):
-      script_path = os.path.abspath(sys.path[0])
-      # Try again looking in the current working directory to match
-      # the layout of the prebuilt o3dConverter binaries.
-      CGC = os.path.join(script_path, 'cgc')
-      if not os.path.exists(CGC):
-        CGC = os.path.join(script_path, 'cgc.exe')
+    print >>sys.stderr, CGC+' is not found, use --cgc option to specify its'
+    print >>sys.stderr, 'location.  You may need to install nvidia cg toolkit.'
+    sys.exit(1)
 
 # cgc complains about TANGENT1 and BINORMAL1 semantics, so we hack it by
 # replacing standard semantics with ATTR8-ATTR12 and then renaming them back to
 # their original names.
 ATTRIBUTES_TO_SEMANTICS = dict(
     attr8 = 'normal',
     attr9 = 'tangent',
     attr10 = 'binormal',
     attr11 = 'tangent1',
     attr12 = 'binormal1')
@@ skipping 113 matching lines @@
   input_mapping = get_input_mapping(header)
   return header + '\n\n' + fix_glsl_body(body, input_mapping)
 
 
 def cg_rename_attributes(cg_shader):
   for new, old in ATTRIBUTES_TO_SEMANTICS.iteritems():
     cg_shader = re.sub(r'\b%s\b' % old.upper(), new.upper(), cg_shader)
   return cg_shader
 
 
-def cg_to_glsl(cg_shader):
+def cg_to_glsl(cg_shader, CGC):
   cg_shader = cg_rename_attributes(cg_shader)
 
   vertex_entry = re.search(r'#o3d\s+VertexShaderEntryPoint\s+(\w+)',
       cg_shader).group(1)
   p = subprocess.Popen([CGC]+('-profile glslv -entry %s' %
                               vertex_entry).split(' '),
       stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
   glsl_vertex, err_v = p.communicate(cg_shader)
 
   fragment_entry = re.search(r'#o3d\s+PixelShaderEntryPoint\s+(\w+)',
       cg_shader).group(1)
   p = subprocess.Popen([CGC]+('-profile glslf -entry %s' %
                               fragment_entry).split(' '),
       stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
   glsl_fragment, err_f = p.communicate(cg_shader)
 
   log = (
       '// glslv profile log:\n' +
       '\n'.join('// ' + l for l in err_v.splitlines()) + '\n\n'
       '// glslf profile log:\n' +
       '\n'.join('// ' + l for l in err_f.splitlines())) + '\n'
 
   return glsl_vertex, glsl_fragment, log
 
 
 def get_matrixloadorder(cg_shader):
   return re.search(r'(?m)^.*#o3d\s+MatrixLoadOrder\b.*$', cg_shader).group(0)
 
 
-def check_cg():
-  if not os.path.exists(CGC):
-    print >>sys.stderr, CGC+' is not found, use --cgc option to specify its'
-    print >>sys.stderr, 'location.  You may need to install nvidia cg toolkit.'
-    sys.exit(1)
-
-
-def main(cg_shader):
+def main(cg_shader, CGC):

[Alexey Marinichev, 2010/04/27 21:28:16]

I used all caps CGC to show it's a constant that's never supposed to change.  I
think it would make sense to either leave it as CGC and not pass it as an extra
argument, or rename it to cgc_path and drag it along.  I'd prefer to keep it
global.

[Ken Russell (switch to Gerrit), 2010/04/28 02:30:49]

I like to avoid globals so I've changed it to cgc_path everywhere.

   matrixloadorder = get_matrixloadorder(cg_shader)
-  glsl_vertex, glsl_fragment, log = cg_to_glsl(cg_shader)
+  glsl_vertex, glsl_fragment, log = cg_to_glsl(cg_shader, CGC)
 
   print log
   print fix_glsl(glsl_vertex)
   print
   print '// #o3d SplitMarker'
   print get_matrixloadorder(cg_shader).strip()
   print
   print fix_glsl(glsl_fragment)
 
 
 if __name__ == '__main__':
+  CGC = default_cgc()
   cmdline_parser = optparse.OptionParser()
   cmdline_parser.add_option('-i', dest='file', default=None,
       help='input shader; standard input if omitted')
   cmdline_parser.add_option('--cgc', dest='CGC', default=CGC,
       help='path to cgc [default: %default]')
   options, args = cmdline_parser.parse_args()
   CGC = options.CGC
-  check_cg()
+  check_cgc(CGC)
 
   try:
     if options.file is None:
       f = sys.stdin
     else:
       f = open(options.file)
     input = f.read()
   except KeyboardInterrupt:
     input = None
 
   if not input:
     cmdline_parser.print_help()
   else:
-    main(input)
+    main(input, CGC)