summaryrefslogtreecommitdiff
path: root/xmake/core/project/cache.lua
blob: 669ec1a032d5b94c2f1a59fe3c740c9bc3119697 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
--!A cross-platform build utility based on Lua
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
--     http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
-- Copyright (C) 2015-present, Xmake Open Source Community.
--
-- @author      ruki
-- @file        cache.lua
--

-- define module
local cache = cache or {}

-- load modules
local io            = require("base/io")
local os            = require("base/os")
local path          = require("base/path")
local table         = require("base/table")
local utils         = require("base/utils")
local config        = require("project/config")
local global        = require("base/global")

-- the cache instance
--
-- @param scopename     local.xxxx
--                      global.xxxx
--
function cache._instance(scopename)

    -- check
    assert(scopename)

    -- init instances
    cache._INSTANCES = cache._INSTANCES or {}
    local instances = cache._INSTANCES

    -- this instance has been initialized?
    if instances[scopename] then
        return instances[scopename]
    end

    -- init instance
    local instance = table.inherit(cache)

    -- memory cache?
    if scopename:startswith("memory.") then
        instance._CACHEDATA = instance._CACHEDATA or {__version = xmake._VERSION_SHORT}
        instances[scopename] = instance
        return instance
    end

    -- check scopename
    if not scopename:find("local%.") and not scopename:find("global%.") then
        os.raise("invalid cache scope: %s", scopename)
    end

    -- make the cache path
    local cachepath = (scopename:gsub("%.", "/"))
    cachepath = (cachepath:gsub("^local%/", path.join(config.directory(), "cache") .. "/"))
    cachepath = (cachepath:gsub("^global%/", path.join(global.cachedir()) .. "/"))

    -- save the cache path
    instance._CACHEPATH = cachepath

    -- load the cache data
    local results = io.load(cachepath)
    if results then
        instance._CACHEDATA = results
    end
    instance._CACHEDATA = instance._CACHEDATA or {__version = xmake._VERSION_SHORT}

    -- save instance
    instances[scopename] = instance

    -- ok
    return instance
end

-- get the cached value
--
-- @param name  the cache key
-- @return      the cached value
--
function cache:get(name)
    return self._CACHEDATA[name]
end

-- set the cached value
--
-- @param name  the cache key
-- @param value the value to cache
--
function cache:set(name, value)
    self._CACHEDATA[name] = value
end

-- clear all cached values
function cache:clear()
    self._CACHEDATA = {__version = xmake._VERSION_SHORT}
end

-- flush cached values to file
function cache:flush()

    -- flush the version
    self._CACHEDATA.__version = xmake._VERSION_SHORT

    -- memory cache? ignore it directly
    if not self._CACHEPATH then
        return
    end

    -- save to file
    local ok, errors = io.save(self._CACHEPATH, self._CACHEDATA)
    if not ok then
        os.raise(errors)
    end
end

-- return module
return cache._instance