[Insight-developers] Renaming txx to hxx and the Wiki
Johnson, Hans J
hans-johnson at uiowa.edu
Tue Jul 19 14:32:45 EDT 2011
Here is a quick reference:
https://itk.icts.uiowa.edu/jira/browse/ITK-147
2) Convert from txx to hxx for file names,
STYLE: Change style develoment tool compliance
PREMISE:
The use of the .txx file extension for indicating the file
that is to hold the implementation of a template class is
only adopted by the ITK community and VNL communities (and has
slightly "infected" a few other small components of other projects).
Increasingly tools are being created to help the programmer better
understand and analyze, and provide hints to proper coding options
dynamically in the development environment (color coding,
auto-completion).
The obscure .txx file requires special configuration of each
development
environment tool to indicate that it is really a c++ header. For new
developers this is often a difficult and frustrating task. This is
confirmed by the large amount of documentation for just a few of the
common editors. Tools that recognize and respect the .hxx extension:
uncrustify, vim, emacs, VisualStudios, clang, SlickEdit,
kwrite, etc....) None of these tools recognize the .txx extension
without
end user customizations.
CONS:
Many files will be changed, and it will not be backwards compatible for
those who accidently included the ".txx" files in their projects. The
.txx
files should not be included in external packages.
BENEFITS:
Implementation files are properly mapped to C++ language type by
default
for improved development environment experience.
CONSIDERATIONS:
There is no obvious single correct solution, but in general a common
theme
from other guides is that the final extension should be ".hxx" or
some suffix that ends with ".h". The extension should be all lower
case
letters (to avoid problems on case insensitive file sysetms).
PROPOSAL:
In ITKv4 (and outside of the ThirdParty directory) change all
implementation files
that currently have a ".txx" extension to have a ".hxx" extension.
An in-depth discussion was held near April 20, 2011 on the
Insight-Developers
mailing list.
--
Hans J. Johnson, Ph.D.
hans-johnson at uiowa.edu
Assistant Professor of Psychiatry
University of Iowa Carver College of Medicine
W278 GH, 200 Hawkins Drive
Iowa City, Iowa 52242
Phone: 319-353-8587
-----Original Message-----
From: Leila Baghdadi <baghdadi at phenogenomics.ca>
Date: Tue, 19 Jul 2011 13:21:34 -0400
To: Bill Lorensen <bill.lorensen at gmail.com>, ITK
<insight-developers at itk.org>
Subject: Re: [Insight-developers] Renaming txx to hxx and the Wiki
Hello Bill,
If I may ask, I checked the wiki and there are alot of itk related pages
and I could not figure out where the difference between these two types of
files and the advantages of switching from one to the other is explained!
I am sure I am missing something ?
a member of your fan club
Leila
----- Original Message -----
From: Bill Lorensen <bill.lorensen at gmail.com>
Sent: Mon, 7/18/2011 5:16pm
To: Insight Developers <insight-developers at itk.org>
Subject: [Insight-developers] Renaming txx to hxx and the Wiki
Folks,
To complete the transition from .txx to .hxx we need to visit the wiki
pages. Some will need editing, others can remain unchanged. We should
not underestimate the value of an up-to-date wiki.
http://itk.org/Wiki/index.php?title=Special:Search&ns0=1&redirs=0&search=tx
x&limit=500&offset=0
Bill
_______________________________________________
Powered by www.kitware.com
Visit other Kitware open-source projects at
http://www.kitware.com/opensource/opensource.html
Kitware offers ITK Training Courses, for more information visit:
http://kitware.com/products/protraining.html
Please keep messages on-topic and check the ITK FAQ at:
http://www.itk.org/Wiki/ITK_FAQ
Follow this link to subscribe/unsubscribe:
http://www.itk.org/mailman/listinfo/insight-developers
_______________________________________________
Powered by www.kitware.com
Visit other Kitware open-source projects at
http://www.kitware.com/opensource/opensource.html
Kitware offers ITK Training Courses, for more information visit:
http://kitware.com/products/protraining.html
Please keep messages on-topic and check the ITK FAQ at:
http://www.itk.org/Wiki/ITK_FAQ
Follow this link to subscribe/unsubscribe:
http://www.itk.org/mailman/listinfo/insight-developers
________________________________
Notice: This UI Health Care e-mail (including attachments) is covered by the Electronic Communications Privacy Act, 18 U.S.C. 2510-2521, is confidential and may be legally privileged. If you are not the intended recipient, you are hereby notified that any retention, dissemination, distribution, or copying of this communication is strictly prohibited. Please reply to the sender that you have received the message in error, then delete it. Thank you.
________________________________
More information about the Insight-developers
mailing list