new version

addresses points made by Ben Cohen

Author: runxel

GDL.py

@@ -9,32 +9,22 @@
 PACKAGE_SETTINGS = "GDL.sublime-settings"
 DEFAULT_AC_PATH = "C:/Program Files/GRAPHISOFT/ARCHICAD 23"
 
-def check_system():
-	""" Returns the file ending of executables depending on the
-		operating system of the user.
-	"""
-	if sys.platform.startswith('darwin'): # OSX
-		return "Contents/MacOS/LP_XMLConverter.app/Contents/MacOS/LP_XMLConverter"
-	elif sys.platform.startswith('win'):  # Windows
-		return "LP_XMLConverter.exe"
-	else:
-		sublime.error_message("GDL build error: Your OS is not supported.")
-		return
 
 def save_all_files():
-	""" Saves all files open in sublime.
+	""" Saves all files open in Sublime.
 		Mimics the 'save on build' behavior of Sublime Text.
 	"""
 	for window in sublime.windows():
 		for view in window.views():
 			if view.file_name() and view.is_dirty():
 				view.run_command("save")
 
-def get_project_data(view, invoke):  # invoke is either 'to-hsf' or 'to-gsm'
+def get_project_data(view, invoke):
 	""" Gets the data of the .sublime-project file.
 		Returns additional arguments for the commandline operation,
 		if the user has set any.
 	"""
+	# invoke options: 'to-hsf' / 'to-gsm' / 'proj_gsm_path'
 	project_data = view.window().project_data()
 	if not project_data:
 		sublime.error_message("You must create a project first! (Project > Save Project As...)")
@@ -51,25 +41,25 @@ def get_project_data(view, invoke):  # invoke is either 'to-hsf' or 'to-gsm'
 	else:
 		sublime.error_message("Something went wrong.")
 		return
-		
+
+# Future addition. Sadly not working as by now.		
 # class AutocompleteCaps(sublime_plugin.EventListener):
 # 	def on_query_completions(self, view, prefix, locations):
 # 		return suggestions
-		
-# go to
-# http://gdl.graphisoft.com/tips-and-tricks/how-to-use-the-lp_xmlconverter-tool
-# for detailed information
-class HsfBuildCommand(sublime_plugin.WindowCommand):
+
+
+class Builder(sublime_plugin.WindowCommand):
 
 	def run(self, *args, **kwargs):
-		self.os = check_system()
+		self.lp_conv_path = self.check_system()
+		self.pckg_settings = sublime.load_settings(PACKAGE_SETTINGS)
+		self.AC_path = str(self.pckg_settings.get("AC_path", DEFAULT_AC_PATH))
+		self.converter = os.path.join(self.AC_path, self.lp_conv_path)
+
 		self.view = self.window.active_view()
 		if self.view.settings().get("auto_save", True):
 			save_all_files()
 
-		settings = sublime.load_settings(PACKAGE_SETTINGS)
-		self.AC_path = str(settings.get("AC_path", DEFAULT_AC_PATH))
-
 		folders = self.window.folders()
 		if len(folders) <= 0:
 			sublime.error_message("GDL build command error: You must have a project open.")
@@ -82,16 +72,25 @@ def run(self, *args, **kwargs):
 				self.multipleFolders = True
 				self.pick_project_folder(folders)
 
-	def on_done_proj(self):
-		# this needs to be in its own function, because
-		#  the sublime text quick panel works asynchronous
-		self.find_gsm()
+	def check_system(self):
+		""" Returns the path to the LP_XML converter.
+		"""
+		if sys.platform.startswith('darwin'): # OSX
+			self.os_win = "false"
+			return "Contents/MacOS/LP_XMLConverter.app/Contents/MacOS/LP_XMLConverter"
+		elif sys.platform.startswith('win'):  # Windows
+			self.os_win = "true"
+			return "LP_XMLConverter.exe"
+		else:
+			sublime.error_message("GDL build error: Your OS is not supported.")
+			return
 
-	def on_done_file(self):
-		self.cmdargs = get_project_data(self.view, 'to-hsf')
-		self.run_hsf()
+	def normpath(self, path):
+		return '"{}"'.format(os.path.normpath(path))
 
 	def pick_project_folder(self, folders):
+		""" Gets called if there are multiple folders in the project. 
+		"""
 		folderNames = []
 		for folder in folders:
 			index = folder.rfind('/') + 1
@@ -110,6 +109,31 @@ def select_project(self, select):
 		self.project_folder = folders[select]
 		self.on_done_proj()  # go on here
 
+	def show_quick_panel(self, options, done):
+		""" Shows the Sublime Text quick panel with the invoked options. """
+		# Sublime Text 3 requires a short timeout between quick panels
+		sublime.set_timeout(lambda: self.window.show_quick_panel(options, done), 10)
+
+
+# 	@classmethod
+# 	def is_enabled(self):
+# 		return "/GDL/" in self.window.active_view().settings().get("syntax")
+
+		
+# go to
+# http://gdl.graphisoft.com/tips-and-tricks/how-to-use-the-lp_xmlconverter-tool
+# for detailed information
+class HsfBuildCommand(Builder):
+	""" Converts a GSM into human readable GDL scripts. """
+
+	def run(self, *args, **kwargs):
+		""" Sublime Text will call this function. """
+		super().run(self)
+
+	def on_done_proj(self):
+		# own function because quick panel is async
+		self.find_gsm()
+
 	def find_gsm(self):
 		self.files = []
 		# r=root, d=directories, f=files
@@ -127,78 +151,47 @@ def find_gsm(self):
 			self.file_to_convert = self.files[0]
 			self.on_done_file()  # go on here
 
+	def on_done_file(self):
+		self.cmdargs = get_project_data(self.view, 'to-hsf')
+		self.run_hsf()
+
 	def select_gsm(self, select):
 		if select < 0:
 			return
 		self.file_to_convert = self.files[select]
 		self.on_done_file()  # go on here
-
-	# Sublime Text 3 requires a short timeout between quick panels
-	def show_quick_panel(self, options, done):
-		sublime.set_timeout(lambda: self.window.show_quick_panel(options, done), 10)
-
+	
 	def run_hsf(self, ):
-		converter = os.path.join(self.AC_path, self.os)
-		cmd = [converter, "libpart2hsf", self.cmdargs, self.file_to_convert, self.project_folder] # cmd, source, dest
+		""" Invokes the LP_XML converter. 
+		"""
+		self.converter = super().normpath(self.converter)
+		self.file_to_convert = super().normpath(self.file_to_convert)
+		self.project_folder = super().normpath(self.project_folder)
+
+		cmd = [self.converter, "libpart2hsf", self.cmdargs, self.file_to_convert, self.project_folder] # cmd, source, dest
 		cmd = list(filter(None, cmd))  # filters out the empty cmdargs. otherwise Macs get hiccups. sigh.
-		log.debug("GDL Command run: " + " ".join(cmd))
-		execCMD = {"cmd": cmd}
+		cmd = " ".join(cmd)
+
+		#log.debug("GDL Command run: " + " ".join(cmd))
+		execCMD = {"shell_cmd": cmd}
 
 		self.window.run_command("exec", execCMD)
 
 ############################################################################
-class LibpartBuildCommand(sublime_plugin.WindowCommand):
+class LibpartBuildCommand(Builder):
+	""" Builds a GSM from the GDL scripts in the project. """
 
 	def run(self, *args, **kwargs):
-		self.os = check_system()
-		self.view = self.window.active_view()
-		if self.view.settings().get("auto_save", True):
-			save_all_files()
-
-		settings = sublime.load_settings(PACKAGE_SETTINGS)
-		self.AC_path = str(settings.get("AC_path", DEFAULT_AC_PATH))
-
-		folders = self.window.folders()
-		if len(folders) <= 0:
-			sublime.error_message("GDL build command error: You must have a project open.")
-		else:
-			if len(folders) == 1:
-				self.multipleFolders = False
-				self.project_folder = folders[0]
-				self.on_done_proj()  # go on here
-			else:
-				self.multipleFolders = True
-				self.pick_project_folder(folders)
+		""" Sublime Text will call this function. """
+		super().run(self)
 
 	def on_done_proj(self):
 		# own function because quick panel is async
 		self.find_hsf()
 
-	def on_done_file(self):
-		self.gsm_name = self.folder_to_convert + ".gsm"
-		self.cmdargs = get_project_data(self.view, 'to-gsm')
-		self.run_libpart()
-
-	def pick_project_folder(self, folders):
-		folderNames = []
-		for folder in folders:
-			index = folder.rfind('/') + 1
-			if index > 0:
-				folderNames.append(folder[index:])
-			else:
-				folderNames.append(folder)
-
-		# self.sel_proj will be called once, with the index of the selected item
-		self.show_quick_panel(folderNames, self.select_project)
-
-	def select_project(self, select):
-		folders = self.window.folders()
-		if select < 0:  # will be -1 if panel was cancelled
-			return
-		self.project_folder = folders[select]
-		self.on_done_proj()  # go on here
-
 	def find_hsf(self):
+		""" Finds all possible folders for converting to GSM. 
+		"""
 		self.folders = [fldr for fldr in os.listdir(self.project_folder) if os.path.isdir(os.path.join(self.project_folder, fldr))]
 
 		if len(self.folders) <= 0:
@@ -211,21 +204,56 @@ def find_hsf(self):
 			self.on_done_file()  # go on here
 
 	def select_hsf(self, select):
+		""" Selects on of the possible of folders of the find_hsf() def. 
+		"""
 		folders = self.folders
 		if select < 0:  # will be -1 if panel was cancelled
 			return
 		self.folder_to_convert = os.path.join(self.project_folder, folders[select])
 		self.on_done_file()  # go on here
 
-	# Sublime Text 3 requires a short timeout between quick panels
-	def show_quick_panel(self, options, done):
-		sublime.set_timeout(lambda: self.window.show_quick_panel(options, done), 10)
+	def on_done_file(self):
+		""" Path handling for GSM output.
+		"""
+		self.global_gsm_path = str(self.pckg_settings.get("global_gsm_path", ""))
+		self.proj_gsm_path = get_project_data(self.view, 'proj_gsm_path')
+
+		output_path = ""
+		if self.proj_gsm_path:  # project based path takes precedence
+			if self.proj_gsm_path != "default":
+				# only set the path if its not 'default' which mimics the standard behavior
+				# TODO implement path check here
+				output_path = self.proj_gsm_path
+		elif self.global_gsm_path:  # otherwise take global path, if set
+			output_path = self.global_gsm_path
+
+		if not output_path:
+			# default path => not global or proj path is set, or proj path says 'default'
+			output_path = os.path.dirname(self.folder_to_convert)
+
+		gsm_name = os.path.basename(os.path.normpath(self.folder_to_convert)) + ".gsm"
+		self.gsm_path = os.path.join(output_path, gsm_name)
+
+		self.cmdargs = get_project_data(self.view, 'to-gsm')
+
+		self.run_libpart()
 
 	def run_libpart(self):
-		converter = os.path.join(self.AC_path, self.os)
-		cmd = [converter, "hsf2libpart", self.cmdargs, self.folder_to_convert, self.gsm_name] # cmd, source, dest
+		""" Invokes the LP_XML converter. 
+		"""
+		self.converter = super().normpath(self.converter)
+		self.folder_to_convert = super().normpath(self.folder_to_convert)
+		self.gsm_path = super().normpath(self.gsm_path)
+
+		cmd = [self.converter, "hsf2libpart", self.cmdargs, self.folder_to_convert, self.gsm_path] # cmd, source, dest
 		cmd = list(filter(None, cmd))  # filters out the empty cmdargs. otherwise Macs get hiccups. sigh.
-		log.debug("GDL Command run: " + " ".join(cmd))
-		execCMD = {"cmd": cmd}
+		cmd = " ".join(cmd)
+		# log.debug("GDL Command run: " + cmd)
+
+		# if you use `cmd` instead of `shell_cmd` you will get the infamous [Winerror 5]
+		# see: https://forum.sublimetext.com/t/winerror-5-access-is-denied/
+		# however, for `shell_cmd` to work we need to pass a string, not a list (!)
+		execCMD = {"shell_cmd": cmd}
 
 		self.window.run_command("exec", execCMD)
+

GDL.sublime-settings

@@ -9,9 +9,14 @@
 
 	"rulers": [80,120],
 
-	// Path to the current Archicad, where the LP_XMLConverter resides
+	// Path to the current Archicad, where the LP_XMLConverter resides.
 	// example Win:
-	"AC_path": "C:/Program Files/GRAPHISOFT/ARCHICAD 23"
+	"AC_path": "C:/Program Files/GRAPHISOFT/ARCHICAD 23",
 	// example Mac:
 	//         "/Applications/GRAPHISOFT/AC23B3/ARCHICAD 23.app"
+
+	// If you specify a path here all conversions from HSF to GSM
+	// will go into this place. This is helpful if you want to deploy
+	// into a central library already linked in Archicad.
+	"global_gsm_path": "",
 }

Messages/install.txt

@@ -24,5 +24,7 @@ Put your settings into the right pane and you're good to go!
 
 Whenever possible, use the "project" feature of Sublime Text, so you can benefit from automatic libpart conversion (via the "LP_XMLConverter") – which means avoiding the pain of copy & pasting every piece of code back into ARCHICAD.
 
+Don't forget to set up your Package Settings!
+
 =========================
       Happy coding!

Messages/v3.1.0.txt

@@ -0,0 +1,39 @@
+
+ ██████╗ ██████╗ ██╗
+██╔════╝ ██╔══██╗██║
+██║  ███╗██║  ██║██║
+██║   ██║██║  ██║██║
+╚██████╔╝██████╔╝███████╗
+ ╚═════╝ ╚═════╝ ╚══════╝
+                         
+GDL Sublime Text package
+has successfully updated
+
+*************************
+
+ＶＥＲＳＩＯＮ 		3.1.0
+
+*************************
+
+• New Package Setting:
+  `global_gsm_path`
+  You can now define a global default path where any
+  GSMs should be deployed to.
+  This is useful if you have a central library 
+  already linked in Archicad.
+  (Thanks to Ben Cohen, http://www.4dlibrary.com.au/,
+  for the suggestion.)
+
+• New Project Setting:
+  `proj_gsm_path`
+  You can also set a conversion path on project basis.
+  This overrides the default (which is project root)
+  and *also* the new `global_gsm_path` from the
+  package setting!
+  Instead of putting a path we can also write `default`
+  which mimics the standard behavior (building the GSM 
+  right next to the HSF).
+
+Note: There's no path checking implemented at the moment! 
+You have to take care by yourself that you're allowed to 
+write at the paths accordingly.