Files
allwpilib/networktables
James Kuszmaul 534ea134a4 artf4154: Get rid of raw pointers in C++.
This deals with the majority of the user-facing code
in wpilibC++Devices and a substantial portion of it in
wpilibC++. wpilibC++Sim and wpilibC++IntegrationTests
are untouched except where it is necessary to make them
work with the rest of the libraries.

There is still a lot to do in the following areas:
-The HAL (which we may not want to touch at all).
-The I2C, Serial, and SPI interfaces in wpilibC++Devices,
  which I haven't gotten around to doing yet.
-Most wpilibC++Devices classes have void* pointers
  for interacting with the HAL.
-InterruptableSensorBase passes a void *params for
  the interrupt handler.
-I haven't converted all the const char* to std::strings.
-There are plenty of other cases of raw pointers still
  existing.
-This doesn't fall directly under raw pointer stuff,
  but move syntax and rvalue references could be introduced
  in many places.
-I haven't touched vision code.
-The Resource classes conflict (one is in the hal, the other
  in wpilibC++). Someone should figure out a more
  permanent fix (eg, just renaming them), then doing
  what I did (making a new namespace for one of them,
  essentially the same as renaming it).

A few other things:
-I created a NullDeleter class which is marked as deprecated.
  What this does is it can be passed as the deleter to a
  std::shared_ptr so that when you are converting raw pointers
  to shared_ptrs the shared_ptr doesn't do any deletion if
  someone else owns the raw pointer. This should only be
  used in making old raw pointer UIs.
-I had to alter the build.gradle so that it did not
  emit errors when deprecated functions called deprecated
  functions. Unfortunately, gradle doesn't appear to be
  actually printing out gcc warnigns for some reason.
  The best way I have found to fix this is to patch
  the toolchains (https://bitbucket.org/byteit101/toolchain-builder/pull-request/5/make-gcc-not-throw-warnings-for-nested/diff)
  so that a deprecated function calling a deprecated
  function is fine but a non-deprecated function calling
  a deprecated function will throw a warning (which we
  then elevate with -Werror). I believe that clang
  deals with this properly, although I have not
  tried it myself.

Change-Id: Ib8090c66893576fe73654f4e9d268f9d37be06a2
2015-07-20 13:18:29 -04:00
..
2015-05-20 16:22:17 -04:00
2015-05-20 16:22:17 -04:00
2014-04-01 11:18:29 -04:00

Purpose

NetworkTables is a HashTable synchronized across the network. It provides a simple interface for sharing numbers, booleans, strings and homogeneous arrays of those components between the robot, driverstation, co-processor and any other computer teams wish to have provide or consume data.

Contributing

  1. Checkout
  2. Edit
  3. Commit
  4. Push using git push origin HEAD:refs/for/master
  5. Wait for code review, checking for comments.

Editing

You can always use any text editor and then build with Maven. Eclipse support works well with the m2eclipse plugin. Individual components may have there own project files.

Building with Maven

Currently, Maven only builds NetworkTables Java and C++. The various table viewer projects have not been migrated yet.

There are multiple build targets that NetworkTables supports. To build it, it is assumed that the toolchains have been setup as described in the WPILib development documentation. In both Java and C++ there are three build targets, Desktop, Azalea and Athena. For Java the Athena and Desktop builds are identical. Building the Desktop versions will run UnitTests on the platform.

  1. cd into the root directory if you want to build both languages. Otherwise, cd into the language you want to build.
  2. Run mvn install if you want to build and install everything.
  3. That's it. You can build only for a specific platform by using Maven profiles. For example, just add -Pdesktop when developing to run the unit tests without compiling for other platforms.