Merge lp:~widelands-dev/widelands/ai-hint-debug into lp:widelands

[Toni Förster]

set correct indent for documentation

Debug builds on travis are failing, because of erroneous indents. This should fix it.

[kaputtnik (franku)]

This happens when running clang_format: it breaks lines at column 100.

Since you are on it: Please make sure the indented lines do not exceed the limit of 100 characters again. Otherwise they will break sphinx again after running clang-format.

Thanks :-)

[kaputtnik (franku)]

Maybe the regular expression for 'CommentPragmas:' in the file '.clang-format' (in the base directory) has to be adjusted?

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4339. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/468090637.
Appveyor build 4134. State: failed. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_ai_hint_debug-4134.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4340. State: errored. Details: https://travis-ci.org/widelands/widelands/builds/468217701.
Appveyor build 4135. State: failed. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_ai_hint_debug-4135.

[GunChleoc (gunchleoc)]

Thanks for fixing this :)

It messes up the Lua comments in the documentation code examples though - see my comments. Best move the complete comments above the line if they don't fit after.

Also, run clang-format locally to double-check that it won't get messed up again when we merge the branch, because bunnybot will execute clang-format automatically.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4343. State: failed. Details: https://travis-ci.org/widelands/widelands/builds/468776979.
Appveyor build 4137. State: failed. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_ai_hint_debug-4137.

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 4344. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/468835505.
Appveyor build 4138. State: failed. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_ai_hint_debug-4138.

[Toni Förster (stonerl)]

Should be alright, now. If nobody objects I would merge this branch into trunk.

[Toni Förster (stonerl)]

@bunnybot merge force

[Toni Förster (stonerl)]

The 'CommentPragmas:' in the file '.clang-format' does work. But it only applies to a line and not a codeblock. According to the documentation this is needed:

// clang-format off
  some code that must not be formatted
// clang-format on

=== modified file 'src/ai/ai_hints.cc'
--- src/ai/ai_hints.cc	2018-12-13 07:24:01 +0000
+++ src/ai/ai_hints.cc	2018-12-17 02:15:24 +0000
@@ -138,7 +138,7 @@
 **collects_ware_from_map**
     The building will generate this ware from the map, e.g. a well mining the ``water`` ware,
     or the hunter returning from the hunt with the ``meat`` ware. The same ware needs also to be
-listed as the first one of the building's outputs, e.g.::
+    listed as the first one of the building's outputs, e.g.::
 
         aihints = {
             collects_ware_from_map = "meat"
@@ -151,7 +151,7 @@
 
     **Note:** The AI expects exactly one such building type for each of the following wares:
     ``fish`` (fisher), ``granite`` (quarry), ``log`` (lumberjack/woodcutter), ``meat`` (hunter),
-``water`` (well).
+    ``water`` (well).
 
 **mines**
     The building will mine to obtain the given ware, e.g.::

=== modified file 'src/graphic/text/rt_parse.cc'
--- src/graphic/text/rt_parse.cc	2018-12-13 07:24:01 +0000
+++ src/graphic/text/rt_parse.cc	2018-12-17 02:15:24 +0000
@@ -209,7 +209,7 @@
 ^^^^^^^^^^
 
 * **padding**: The rectangle of this tag is shrunk so leave a gap on its outside, on all four outer
-edges.
+  edges.
 * **padding_r**: Padding on the right-hand side
 * **padding_l**: Padding on the left-hand side
 * **padding_b**: Padding on the bottom
@@ -218,7 +218,7 @@
 * **background**: Give this tag's rectangle a background color as a hex value.
 
 * **keep_spaces**: Do now trim away trailing and double spaces. Use this where the user is editing
-text.
+  text.
 * **db_show_spaces**: Highlight all blank spaces for debugging purposes.
 
 Sub-tags
@@ -264,11 +264,11 @@
 The same attributes as :ref:`rt_tags_rt`, plus the following:
 
 * **margin**: Shrink all contents to leave a margin towards the outer edge of this tag's rectangle.
-* **float**: Make text float around this div. Allowed values are ``left``,  ``right``.
+* **float**: Make text float around this div. Allowed values are ``left``, ``right``.
   The structure has to be something like: ``div("width=100%", div("float=left padding_r=6",
-p(img(imagepath))) .. p(text))``, with the first embedded div being the floating one.
+  p(img(imagepath))) .. p(text))``, with the first embedded div being the floating one.
 * **valign**: Align the contents vertically. Allowed values are ``top`` (default), ``center`` or
-``middle``, ``bottom``.
+  ``middle``, ``bottom``.
 * **width**: The width of this element, as a pixel amount, or as a percentage.
   The last ``div`` in a row can be expanded automatically by using ``*``.
 
@@ -484,7 +484,7 @@
 * **ref**: To be implemented
 * **color**: Player color for the image as a hex value
 * **width**: Width of the image as a pixel amount. The corresponding height will be matched
-automatically.
+  automatically.
 
 :ref:`Return to tag index<rt_tags>`
 		*/

=== modified file 'src/logic/map_objects/tribes/worker_program.cc'
--- src/logic/map_objects/tribes/worker_program.cc	2018-12-13 07:24:01 +0000
+++ src/logic/map_objects/tribes/worker_program.cc	2018-12-17 02:15:24 +0000
@@ -271,13 +271,20 @@
 
       cut_granite = {
          "findobject=attrib:rocks radius:6", -- Find rocks on the map within a radius of 6 from your
-building "walk=object", -- Now walk to those rocks "playsound=sound/atlanteans/cutting stonecutter
-192", "animate=hacking 12000", "callobject=shrink", "createware=granite", "return"
+         building
+         "walk=object", -- Now walk to those rocks
+         "playsound=sound/atlanteans/cutting stonecutter 192",
+         "animate=hacking 12000",
+         "callobject=shrink",
+         "createware=granite",
+         "return"
       },
 
       hunt = {
          "findobject=type:bob radius:13 attrib:eatable", -- Find an eatable bob (animal) within a
-radius of 13 from your building "walk=object", -- Walk to where the animal is "animate=idle 1500",
+         radius of 13 from your building
+         "walk=object", -- Walk to where the animal is
+         "animate=idle 1500",
          "removeobject",
          "createware=meat",
          "return"
@@ -327,7 +334,7 @@
 findspace
 ^^^^^^^^^
 .. function:: findspace=size:\<plot\> radius:\<distance\> [breed] [resource:\<name\>]
-[avoid:\<immovable_attribute\>] [saplingsearches:\<number\>] [space]
+   [avoid:\<immovable_attribute\>] [saplingsearches:\<number\>] [space]
 
    :arg string size: The size or building plot type of the free space.
       The possible values are:
@@ -362,13 +369,19 @@
    The field can then be used in other commands like ``walk``. Examples::
 
       breed = {
-         "findspace=size:any radius:7 breed resource:fish", -- Find any field that can have fish in
-it for adding a fish to it below "walk=coords", "animate=freeing 3000", "breed=fish 1", "return"
+         -- Find any field that can have fish in it for adding a fish to it below
+         "findspace=size:any radius:7 breed resource:fish",
+         "walk=coords",
+         "animate=freeing 3000",
+         "breed=fish 1",
+         "return"
       },
 
       plant = {
-         "findspace=size:any radius:5 avoid:field saplingsearches:8", -- Don't get in the way of the
-farmer's crops when planting trees. Retry 8 times. "walk=coords", "animate=dig 2000",
+         -- Don't get in the way of the farmer's crops when planting trees. Retry 8 times.
+         "findspace=size:any radius:5 avoid:field saplingsearches:8",
+         "walk=coords",
+         "animate=dig 2000",
          "animate=planting 1000",
          "plant=attrib:tree_sapling",
          "animate=water 2000",
@@ -376,8 +389,11 @@
       },
 
       plant = {
-         "findspace=size:any radius:2 space", -- The farmer will want to walk to this field again
-later for harvesting his crop "walk coords", "animate=planting 4000", "plant=attrib:seed_wheat",
+         -- The farmer will want to walk to this field again later for harvesting his crop
+         "findspace=size:any radius:2 space",
+         "walk=coords",
+         "animate=planting 4000",
+         "plant=attrib:seed_wheat",
          "animate=planting 4000",
          "return",
       },
@@ -497,9 +513,13 @@
 
       buildship = {
          "walk=object-or-coords", -- Walk to coordinates from 1. or to object from 2.
-         "plant=attrib:shipconstruction unless object", -- 2. This will create an object for us if
-we don't have one yet "playsound=sound/sawmill sawmill 230", "animate=work 500", "construct", -- 1.
-This will find a space for us if no object has been planted yet "animate=work 5000", "return"
+         -- 2. This will create an object for us if we don't have one yet
+         "plant=attrib:shipconstruction unless object",
+         "playsound=sound/sawmill sawmill 230",
+         "animate=work 500",
+         "construct", -- 1. This will find a space for us if no object has been planted yet
+         "animate=work 5000",
+         "return"
       },
 */
 /**
@@ -646,14 +666,19 @@
          "findspace=size:any radius:2 space",
          "walk=coords",
          "animate=planting 4000",
-         "plant=attrib:seed_wheat", -- Plant the tiny field immovable that the worker's tribe knows
-about "animate=planting 4000", "return",
+         -- Plant the tiny field immovable that the worker's tribe knows about
+         "plant=attrib:seed_wheat",
+         "animate=planting 4000",
+         "return",
       },
 
       buildship = {
          "walk=object-or-coords",
-         "plant=attrib:shipconstruction unless object", -- Only create a shipconstruction if we
-don't already have one "playsound=sound/sawmill sawmill 230", "animate=work 500", "construct",
+         -- Only create a shipconstruction if we don't already have one
+         "plant=attrib:shipconstruction unless object",
+         "playsound=sound/sawmill sawmill 230",
+         "animate=work 500",
+         "construct",
          "animate=work 5000",
          "return"
       }
@@ -743,8 +768,10 @@
          "findobject=type:bob radius:13 attrib:eatable", -- Select an object to remove
          "walk=object",
          "animate=idle 1000",
-         "removeobject", -- The selected eatable map object has been hunted, so remove it from the
-map "createware=meat", "return"
+         -- The selected eatable map object has been hunted, so remove it from the map
+         "removeobject",
+         "createware=meat",
+         "return"
       }
 */
 void WorkerProgram::parse_removeobject(Worker::Action* act, const std::vector<std::string>&) {
@@ -805,8 +832,8 @@
          "animate=idle 2000",
          "playsound=sound/hammering geologist_hammer 192",
          "animate=hacking 3000",
-         "findresources" -- Plant a resource marker at the current location, according to what has
-been found.
+         -- Plant a resource marker at the current location, according to what has been found.
+         "findresources"
       }
 */
 void WorkerProgram::parse_findresources(Worker::Action* act, const std::vector<std::string>& cmd) {
@@ -894,10 +921,15 @@
 
       buildship = {
          "walk=object-or-coords", -- Walk to coordinates from 1. or to object from 2.
-         "plant=attrib:shipconstruction unless object", -- 2. This will create an object for us if
-we don't have one yet "playsound=sound/sawmill sawmill 230", "animate=work 500", "construct", -- 1.
-Add the current ware to the shipconstruction. This will find a space for us if no shipconstruction
-object has been planted yet "animate=work 5000", "return"
+         -- 2. This will create an object for us if we don't have one yet
+         "plant=attrib:shipconstruction unless object",
+         "playsound=sound/sawmill sawmill 230",
+         "animate=work 500",
+         -- 1. Add the current ware to the shipconstruction. This will find a space for us if no
+         -- shipconstruction object has been planted yet
+         "construct",
+         "animate=work 5000",
+         "return"
       },
 */
 /**

=== modified file 'src/scripting/lua_bases.cc'
--- src/scripting/lua_bases.cc	2018-12-13 07:24:01 +0000
+++ src/scripting/lua_bases.cc	2018-12-17 02:15:24 +0000
@@ -400,9 +400,9 @@
       Saves information that can be read by other scenarios.
 
       If an array is used, the data will be saved in the correct order. Arrays may not contain nil
-   values. If the table is not an array, all keys have to be strings. Tables may contain subtables
-   of any depth. Cyclic dependencies will cause Widelands to crash. Only tables/arrays, strings,
-   integer numbers and booleans may be used as values.
+      values. If the table is not an array, all keys have to be strings. Tables may contain subtables
+      of any depth. Cyclic dependencies will cause Widelands to crash. Only tables/arrays, strings,
+      integer numbers and booleans may be used as values.
 */
 int LuaEditorGameBase::save_campaign_data(lua_State* L) {
 

=== modified file 'src/scripting/lua_globals.cc'
--- src/scripting/lua_globals.cc	2018-12-13 07:24:01 +0000
+++ src/scripting/lua_globals.cc	2018-12-17 02:15:24 +0000
@@ -198,7 +198,7 @@
 .. function:: pgettext(msgctxt, msgid)
 
    A wrapper for the pgettext() function, needed for allowing multiple translations of the same
-string according to context.
+   string according to context.
 
    :arg msgctxt: a named context for this string for disambiguation
    :type msgctxt: :class:`string`
@@ -253,7 +253,7 @@
 .. function:: ticks()
 
    Returns an integer value representing the number of milliseconds since the SDL library
-initialized.
+   initialized.
 */
 static int L_ticks(lua_State* L) {
 	lua_pushinteger(L, SDL_GetTicks());

=== modified file 'src/scripting/lua_map.cc'
--- src/scripting/lua_map.cc	2018-12-13 07:24:01 +0000
+++ src/scripting/lua_map.cc	2018-12-17 02:15:24 +0000
@@ -1429,7 +1429,7 @@
    .. attribute:: buildings
 
       (RO) an array of :class:`LuaBuildingDescription` with all the buildings that the tribe can
-   use, casted to their appropriate subclasses.
+      use, casted to their appropriate subclasses.
 */
 int LuaTribeDescription::get_buildings(lua_State* L) {
 	const TribeDescr& tribe = *get();
@@ -1492,7 +1492,7 @@
    .. attribute:: immovables
 
       (RO) an array of :class:`LuaImmovableDescription` with all the immovables that the tribe can
-   use.
+      use.
 */
 int LuaTribeDescription::get_immovables(lua_State* L) {
 	const TribeDescr& tribe = *get();
@@ -1665,8 +1665,8 @@
    This class contains the properties that are common to all map objects such as buildings or wares.
 
    The dynamic MapObject class corresponding to this class is the base class for all Objects in
-widelands, including immovables and Bobs. This class can't be instantiated directly, but provides
-the base for all others.
+   widelands, including immovables and Bobs. This class can't be instantiated directly, but provides
+   the base for all others.
 */
 const char LuaMapObjectDescription::className[] = "MapObjectDescription";
 const MethodType<LuaMapObjectDescription> LuaMapObjectDescription::Methods[] = {
@@ -1820,7 +1820,7 @@
                automatically placed next to each port building.
 
          * **Abstract:** These types are abstract map objects that are used by the engine and are
-   not visible on the map.
+           not visible on the map.
 
            * :class:`battle <BattleDescription>`, holds information
              about two soldiers in a fight,
@@ -1841,8 +1841,8 @@
    Child of: :class:`MapObjectDescription`
 
    A static description of a :class:`base immovable <BaseImmovable>`, so it can be used in help
-files without having to access an actual immovable on the map. See also
-:class:`MapObjectDescription` for more properties.
+   files without having to access an actual immovable on the map. See also
+   :class:`MapObjectDescription` for more properties.
 */
 const char LuaImmovableDescription::className[] = "ImmovableDescription";
 const MethodType<LuaImmovableDescription> LuaImmovableDescription::Methods[] = {
@@ -1907,7 +1907,7 @@
          the name and descname of the editor category of this immovable
 
          (RO) a table with "name" and "descname" entries for the editor category, or nil if it has
-   none.
+         none.
 */
 int LuaImmovableDescription::get_editor_category(lua_State* L) {
 	const EditorCategory* editor_category = get()->editor_category();
@@ -2154,7 +2154,7 @@
    .. attribute:: enhanced_from
 
          (RO) returns the building that this was enhanced from, or nil if this isn't an enhanced
-   building.
+         building.
 */
 int LuaBuildingDescription::get_enhanced_from(lua_State* L) {
 	if (get()->is_enhanced()) {
@@ -2280,7 +2280,7 @@
 .. class:: ConstructionSiteDescription
 
    Child of: :class:`MapObjectDescription`, :class:`ImmovableDescription`,
-:class:`BuildingDescription`
+   :class:`BuildingDescription`
 
    A static description of a tribe's constructionsite, so it can be used in help files
    without having to access an actual building on the map.
@@ -2301,7 +2301,7 @@
 .. class:: DismantleSiteDescription
 
    Child of: :class:`MapObjectDescription`, :class:`ImmovableDescription`,
-:class:`BuildingDescription`
+   :class:`BuildingDescription`
 
    A static description of a tribe's dismantlesite, so it can be used in help files
    without having to access an actual building on the map.
@@ -2322,7 +2322,7 @@
 .. class:: ProductionSiteDescription
 
    Child of: :class:`MapObjectDescription`, :class:`ImmovableDescription`,
-:class:`BuildingDescription`
+   :class:`BuildingDescription`
 
    A static description of a tribe's productionsite, so it can be used in help files
    without having to access an actual building on the map.
@@ -2451,10 +2451,10 @@
    .. attribute:: consumed_wares_workers
 
       :arg program_name: the name of the production program that we want to get the consumed wares
-   for :type tribename: :class:`string`
+         for :type tribename: :class:`string`
 
       (RO) Returns a table of {{ware name}, ware amount} for the wares consumed by this production
-   program. Multiple entries in {ware name} are alternatives (OR logic)).
+      program. Multiple entries in {ware name} are alternatives (OR logic)).
 */
 int LuaProductionSiteDescription::consumed_wares_workers(lua_State* L) {
 	std::string program_name = luaL_checkstring(L, -1);
@@ -2485,10 +2485,10 @@
    .. attribute:: produced_wares
 
       :arg program_name: the name of the production program that we want to get the produced wares
-   for :type tribename: :class:`string`
+         for :type tribename: :class:`string`
 
          (RO) Returns a table of {ware name, ware amount} for the wares produced by this production
-   program
+         program
 */
 int LuaProductionSiteDescription::produced_wares(lua_State* L) {
 	std::string program_name = luaL_checkstring(L, -1);
@@ -2504,7 +2504,7 @@
    .. attribute:: recruited_workers
 
       :arg program_name: the name of the production program that we want to get the recruited
-   workers for :type tribename: :class:`string`
+         workers for :type tribename: :class:`string`
 
          (RO) Returns a table of {worker name, worker amount} for the workers recruited
          by this production program
@@ -2526,7 +2526,7 @@
 .. class:: MilitarySiteDescription
 
    Child of: :class:`MapObjectDescription`, :class:`ImmovableDescription`,
-:class:`BuildingDescription`
+   :class:`BuildingDescription`
 
    A static description of a tribe's militarysite, so it can be used in help files
    without having to access an actual building on the map.
@@ -2578,12 +2578,12 @@
 .. class:: TrainingSiteDescription
 
    Child of: :class:`MapObjectDescription`, :class:`ImmovableDescription`,
-:class:`BuildingDescription`, :class:`ProductionSiteDescription`
+   :class:`BuildingDescription`, :class:`ProductionSiteDescription`
 
    A static description of a tribe's trainingsite, so it can be used in help files
    without having to access an actual building on the map.
    A training site can train some or all of a soldier's properties (Attack, Defense, Evade and
-Health). See the parent classes for more properties.
+   Health). See the parent classes for more properties.
 */
 const char LuaTrainingSiteDescription::className[] = "TrainingSiteDescription";
 const MethodType<LuaTrainingSiteDescription> LuaTrainingSiteDescription::Methods[] = {
@@ -2850,7 +2850,7 @@
 .. class:: WarehouseDescription
 
    Child of: :class:`MapObjectDescription`, :class:`ImmovableDescription`,
-:class:`BuildingDescription`
+   :class:`BuildingDescription`
 
    A static description of a tribe's warehouse, so it can be used in help files
    without having to access an actual building on the map.
@@ -2891,7 +2891,7 @@
 .. class:: MarketDescription
 
    Child of: :class:`MapObjectDescription`, :class:`ImmovableDescription`,
-:class:`BuildingDescription`
+   :class:`BuildingDescription`
 
    A static description of a tribe's market, so it can be used in help files
    without having to access an actual building on the map. A Market is used for
@@ -3401,7 +3401,7 @@
       :arg amount: The amount of the resource what we want an overlay image for
 
          (RO) the :class:`string` path to the image representing the specified amount of this
-   resource
+         resource
 */
 int LuaResourceDescription::editor_image(lua_State* L) {
 	if (lua_gettop(L) != 2) {
@@ -3480,7 +3480,7 @@
    .. attribute:: get_default_resource
 
          (RO) the :class:`wl.map.ResourceDescription` for the default resource provided by this
-   terrain, or nil if the terrain has no default resource.
+         terrain, or nil if the terrain has no default resource.
 */
 
 int LuaTerrainDescription::get_default_resource(lua_State* L) {
@@ -3510,7 +3510,7 @@
    .. attribute:: the name and descname of the editor category of this terrain
 
       (RO) a table with "name" and "descname" entries for the editor category, or nil if it has
-   none.
+      none.
 */
 int LuaTerrainDescription::get_editor_category(lua_State* L) {
 	const EditorCategory* editor_category = get()->editor_category();
@@ -3576,7 +3576,7 @@
    .. attribute:: valid_resources
 
          (RO) a list of :class:`wl.map.ResourceDescription` with all valid resources for this
-   terrain.
+         terrain.
 */
 
 int LuaTerrainDescription::get_valid_resources(lua_State* L) {