Add dirty flag and integrate

[dmwever]

fixes #1679. First time working with c++. Been struggling to update a test and getting it to build. Any advice will be helpful. I am using Visual Studio Code.

Please offer much critique. Complain with vigor. Correct with fervor.

[dmwever]

A few questions I have for this:
First, how to I integrate the clock with the Map/Terrain/Pathfinding subsystem? I don't just want to start passing the clock through everything, but it seems like, with this task, as well as the Cost Stamp and Record History issues, time will be needed in the pathfinding system. How will this be integrated?

Also, would it be good practice to include non-time based overrides for CostField set_cost which simply set the time to TIME_ZERO for initialization? I have done this for the CostField function that is used by the Map class, but only to avoid needing to pass in a time_t from the map.

Lastly, how do I run with debugging using Visual Studio Code? I make changes to a file and run, but it ignores my breakpoints.

[heinezen]

First, how to I integrate the clock with the Map/Terrain/Pathfinding subsystem? I don't just want to start passing the clock through everything, but it seems like, with this task, as well as the Cost Stamp and Record History issues, time will be needed in the pathfinding system. How will this be integrated?

Where would you need to pass the clock? You very likely only need to pass the time value but the clock is not necessary IMO.

Also, would it be good practice to include non-time based overrides for CostField set_cost which simply set the time to TIME_ZERO for initialization? I have done this for the CostField function that is used by the Map class, but only to avoid needing to pass in a time_t from the map.

That would kind of counteract introducing dirty flags, so I'm not sure if this is a good idea. In fact, I'm not really sure why we should just always pass a time. Initialization does not always happen at time zero.

Lastly, how do I run with debugging using Visual Studio Code? I make changes to a file and run, but it ignores my breakpoints.

It should just work out of the box. What is your start configuration and output?

[dmwever]

First, how to I integrate the clock with the Map/Terrain/Pathfinding subsystem? I don't just want to start passing the clock through everything, but it seems like, with this task, as well as the Cost Stamp and Record History issues, time will be needed in the pathfinding system. How will this be integrated?

Where would you need to pass the clock? You very likely only need to pass the time value but the clock is not necessary IMO.

Perhaps that's a better question. How to get the time (or any time) into the Map subsystem.

[heinezen]

Perhaps that's a better question. How to get the time (or any time) into the Map subsystem.

The update time comes from events in the event system that will trigger a map update. However, I wouldn't worry about that right now, since it is not implemented yet.

[dmwever]

It should just work out of the box. What is your start configuration and output?

If you are talking about the configurations in launch.json, it says:
"configurations": []

That's probably my problem lol. What should it say?

[heinezen]

Something like this should work as a configuration:

{
    "name": "Main",
    "type": "cppdbg",
    "request": "launch",
    "cwd": "${workspaceFolder}/bin",
    "program": "${workspaceFolder}/bin/run",
    "args": [
        "main",
        "--verbose",
        "--gl-debug",
    ],
    "setupCommands": [
        {
            "description": "Enable pretty-printing for gdb",
            "text": "-enable-pretty-printing",
            "ignoreFailures": true
        },
        {
            "text": "source ${workspaceFolder}/etc/openage.gdbinit"
        }
    ],
}

[dmwever]

Something like this should work as a configuration:

{
    "name": "Main",
    "type": "cppdbg",
    "request": "launch",
    "cwd": "${workspaceFolder}/bin",
    "program": "${workspaceFolder}/bin/run",
    "args": [
        "main",
        "--verbose",
        "--gl-debug",
    ],
    "setupCommands": [
        {
            "description": "Enable pretty-printing for gdb",
            "text": "-enable-pretty-printing",
            "ignoreFailures": true
        },
        {
            "text": "source ${workspaceFolder}/etc/openage.gdbinit"
        }
    ],
}

So to clarify, I should put this in launch.json? I am used to Visual Studio with C#.

[heinezen]

You should put it in the configurations array, yes.

[dmwever]

You should put it in the configurations array, yes.

[workspace]/bin/run does not exist

[heinezen]

Well, you need to build the project before running :D

[heinezen]

https://github.com/SFTtech/openage/blob/master/doc/building.md has info on the build procedure.

[dmwever]

https://github.com/SFTtech/openage/blob/master/doc/building.md has info on the build procedure.

I can't seem to get this process working on windows. I can run using python openage, following the info on this page:
https://github.com/SFTtech/openage/blob/master/doc/build_instructions/windows_msvc.md

But I don't see a bin folder built in openage following the Windows instructions.

[dmwever]

Marking as ready for review, as most of the ground work is laid. There is a seg fault on demo 1 I cannot track using breakpoints, because I cannot get debugging to work with the demo tests using the Windows Build Instructions page. I assume there is a simple error I am making with c++ unordered maps, but I cannot use breakpoint tools at the moment.

The seg fault occurs when accessing the Field Cache in the is_cached method. Aside from that, we are looking pretty good here.

[jere8184]

because I cannot get debugging to work with the demo tests using the

Building via

Marking as ready for review, as most of the ground work is laid. There is a seg fault on demo 1 I cannot track using breakpoints, because I cannot get debugging to work with the demo tests using the Windows Build Instructions page. I assume there is a simple error I am making with c++ unordered maps, but I cannot use breakpoint tools at the moment.

The seg fault occurs when accessing the Field Cache in the is_cached method. Aside from that, we are looking pretty good here.

cmake --build . --config RelWithDebInfo should produce debug symbols that you can then provide to your debugger, to allow you to use breakpoints , if you want further assistance feel free to reach out on matrix :)

[heinezen]

I fixed your segfault and a few other things. The segfault happened because the field cache was not initialized in the Integrator's constructor.

The only thing left to do for you now is to add yourself (and your commit mail) to copying.md and we can merge :)

[dmwever]

Added to copying.md!

[heinezen]

Here we go!