Use basedir instead of os.getcwd().

Author: tritao

modules/gmake/tests/cpp/test_make_pch.lua

@@ -17,7 +17,6 @@
 
 	local wks, prj
 	function suite.setup()
-		os.chdir(_TESTS_DIR)
 		wks, prj = test.createWorkspace()
 	end
 
@@ -71,15 +70,32 @@
 
 
 --
--- The PCH can be specified relative the an includes search path.
+-- The PCH can be specified relative to the includes search path.
 --
 
-	function suite.pch_searchesIncludeDirs()
+	function suite.pch_searchesIncludeDirs_location()
 		pchheader "premake.h"
-		includedirs { "../../../src/host" }
+		includedirs { "src/host" }
 		prepareVars()
 		test.capture [[
-  PCH = ../../../src/host/premake.h
+  PCH = src/host/premake.h
+		]]
+	end
+
+
+--
+-- The PCH can be specified relative to the includes search path.
+-- Due to the location being different from _MAIN_SCRIPT_DIR,
+-- the specified PCH path should be relative to the location.
+
+
+	function suite.findsPCH_onIncludeDirs()
+		location "MyProject"
+		pchheader "premake.h"
+		includedirs { "src/host" }
+		prepareVars()
+		test.capture [[
+  PCH = ../src/host/premake.h
 		]]
 	end
 
@@ -123,20 +139,3 @@ $(OBJECTS): | $(OBJDIR)
 endif
 		]]
 	end
-
-
-
-	--
-	-- If the header is located on one of the include file
-	-- search directories, it should get found automatically.
-	--
-
-		function suite.findsPCH_onIncludeDirs()
-			location "MyProject"
-			pchheader "premake.h"
-			includedirs { "../../../src/host" }
-			prepareVars()
-			test.capture [[
-  PCH = ../../../../src/host/premake.h
-			]]
-		end

modules/gmake2/tests/test_gmake2_pch.lua

@@ -20,7 +20,6 @@
 
 	local wks, prj
 	function suite.setup()
-		os.chdir(_TESTS_DIR)
 		gmake2.cpp.initialize()
 		wks, prj = test.createWorkspace()
 	end
@@ -95,15 +94,30 @@ GCH = $(PCH_PLACEHOLDER).gch
 
 
 --
--- The PCH can be specified relative the an includes search path.
+-- The PCH can be specified relative to the includes search path.
 --
 
 	function suite.pch_searchesIncludeDirs()
 		pchheader "premake.h"
-		includedirs { "../../../src/host" }
+		includedirs { "src/host" }
 		prepareVars()
 		test.capture [[
-PCH = ../../../src/host/premake.h
+PCH = src/host/premake.h
+		]]
+	end
+
+--
+-- The PCH can be specified relative to the includes search path.
+-- Due to the location being different from _MAIN_SCRIPT_DIR,
+-- the specified PCH path should be relative to the location.
+
+	function suite.pch_searchesIncludeDirs_location()
+		location "MyProject"
+		pchheader "premake.h"
+		includedirs { "src/host" }
+		prepareVars()
+		test.capture [[
+PCH = ../src/host/premake.h
 		]]
 	end
 
@@ -160,23 +174,6 @@ endif
 		]]
 	end
 
-
-
-	--
-	-- If the header is located on one of the include file
-	-- search directories, it should get found automatically.
-	--
-
-		function suite.findsPCH_onIncludeDirs()
-			location "MyProject"
-			pchheader "premake.h"
-			includedirs { "../../../src/host" }
-			prepareVars()
-			test.capture [[
-PCH = ../../../../src/host/premake.h
-			]]
-		end
-
 --
 -- If the header is located on one of the include file
 -- search directories, it should get found automatically.

modules/self-test/test_runner.lua

@@ -91,6 +91,10 @@
 		_TESTS_DIR = test.suite._TESTS_DIR
 		_SCRIPT_DIR = test.suite._SCRIPT_DIR
 
+		-- Currently the test suite paths are tested against as if all tests are
+		-- running with the repository root as their base working directory.
+		_BASE_DIR = _MAIN_SCRIPT_DIR
+
 		m.suiteName = test.suiteName
 		m.testName = test.testName
 

src/base/api.lua

@@ -148,7 +148,7 @@
 		-- if I have an existing instance, create a new configuration
 		-- block for it so I don't pick up an old filter
 		if instance then
-			configset.addFilter(instance, {}, os.getcwd())
+			configset.addFilter(instance, {}, api.scope.current.basedir)
 		end
 
 		-- otherwise, a new instance
@@ -163,7 +163,7 @@
 		-- (recursive call, so needs to be its own function)
 		api._clearContainerChildren(class)
 
-		-- active this container, as well as it ancestors
+		-- active this container, as well as its ancestors
 		if not class.placeholder then
 			api.scope.current = instance
 		end
@@ -716,7 +716,7 @@
 			table.remove(api.scope.global.blocks, i)
 		end
 
-		configset.addFilter(api.scope.current, {}, os.getcwd())
+		configset.addFilter(api.scope.current, {}, api.scope.current.basedir)
 	end
 
 
@@ -1087,7 +1087,7 @@
 	premake.field.kind("path", {
 		paths = true,
 		store = function(field, current, value, processor)
-			return path.deferredjoin(os.getcwd(), value)
+			return path.deferredjoin(p.api.scope.current.basedir, value)
 		end,
 		compare = function(field, a, b, processor)
 			return (a == b)
@@ -1152,7 +1152,7 @@
 			if (type(terms) == "table" and #terms == 1 and terms[1] == "*") or (terms == "*") then
 				terms = nil
 			end
-			local ok, err = configset.addFilter(api.scope.current, {terms}, os.getcwd())
+			local ok, err = configset.addFilter(api.scope.current, {terms}, api.scope.current.basedir)
 			if not ok then
 				error(err, 2)
 			end

src/base/container.lua

@@ -78,7 +78,8 @@
 		self.name = name
 		self.filename = name
 		self.script = _SCRIPT
-		self.basedir = os.getcwd()
+		self.scriptdir = _SCRIPT_DIR
+		self.basedir = _BASE_DIR or _SCRIPT_DIR
 		self.external = false
 
 		for childClass in container.eachChildClass(class) do

src/base/context.lua

@@ -49,7 +49,7 @@
 		-- expected that the creator of the context will set this value using
 		-- the setbasedir() function.
 
-		ctx._basedir = os.getcwd()
+		ctx._basedir = cfgset.basedir
 
 		-- when a missing field is requested, fetch it from my config
 		-- set, and then cache the value for future lookups

tests/api/test_path_kind.lua

@@ -34,5 +34,5 @@
 
 	function suite.convertsToAbsolute()
 		testapi "self/local.h"
-		test.isequal(os.getcwd() .. "/self/local.h", api.scope.project.testapi)
+		test.isequal(_BASE_DIR .. "/self/local.h", api.scope.project.testapi)
 	end

tests/config/test_linkinfo.lua

@@ -35,7 +35,7 @@
 	function suite.directoryIsTargetDir_onTargetDir()
 		targetdir "../bin"
 		i = prepare()
-		test.isequal("../bin", path.getrelative(os.getcwd(), i.directory))
+		test.isequal("../bin", path.getrelative(_BASE_DIR, i.directory))
 	end
 
 
@@ -48,7 +48,7 @@
 		targetdir "../bin"
 		implibdir "../lib"
 		i = prepare()
-		test.isequal("../lib", path.getrelative(os.getcwd(), i.directory))
+		test.isequal("../lib", path.getrelative(_BASE_DIR, i.directory))
 	end
 
 

website/docs/basedir.md

@@ -1,10 +1,12 @@
 Sets the base directory for a configuration, from with other paths contained by the configuration will be made relative at export time.
 
+This base directory is used when expanding path tokens encountered in non-path values. Such values will be made relative to this value so the resulting projects will only contain relative paths.
+
 ```lua
 basedir ("value")
 ```
 
-You do not normally need to set this value, as it is filled in automatically with the current working directory at the time the configuration block is created by the script.
+You do not normally need to set this value, as it is filled in automatically with the current script directory ([`_SCRIPT_DIR`](globals/premake_MAIN_SCRIPT_DIR.md)) at the time the configuration block is created by the script.
 
 ### Parameters ###